From 7c30e3c5ea061cbb7ab814b979b9895d958f678b Mon Sep 17 00:00:00 2001 From: Loren Segal Date: Wed, 8 Oct 2014 18:09:07 -0700 Subject: [PATCH] Merge aws-sdk-apis package into aws-sdk. This commit removes and deprecates the aws-sdk-apis dependency. --- .npmignore | 2 +- apis/autoscaling-2011-01-01.api.json | 1336 ++ apis/autoscaling-2011-01-01.full.json | 3063 +++ apis/autoscaling-2011-01-01.paginators.json | 52 + apis/cloudformation-2010-05-15.api.json | 527 + apis/cloudformation-2010-05-15.full.json | 1306 ++ .../cloudformation-2010-05-15.paginators.json | 27 + apis/cloudfront-2014-05-31.api.json | 1497 ++ apis/cloudfront-2014-05-31.full.json | 3540 +++ apis/cloudfront-2014-05-31.paginators.json | 32 + apis/cloudfront-2014-05-31.waiters.json | 29 + apis/cloudsearch-2011-02-01.api.json | 837 + apis/cloudsearch-2011-02-01.full.json | 2093 ++ apis/cloudsearch-2011-02-01.paginators.json | 13 + apis/cloudsearch-2013-01-01.api.json | 1064 + apis/cloudsearch-2013-01-01.full.json | 2655 +++ apis/cloudsearch-2013-01-01.paginators.json | 20 + apis/cloudsearchdomain-2013-01-01.api.json | 260 + apis/cloudsearchdomain-2013-01-01.full.json | 510 + apis/cloudtrail-2013-11-01.api.json | 183 + apis/cloudtrail-2013-11-01.full.json | 773 + apis/cloudtrail-2013-11-01.paginators.json | 7 + apis/cognito-identity-2014-06-30.api.json | 324 + apis/cognito-identity-2014-06-30.full.json | 1289 ++ apis/cognito-sync-2014-06-30.api.json | 440 + apis/cognito-sync-2014-06-30.full.json | 1196 + apis/datapipeline-2012-10-29.api.json | 518 + apis/datapipeline-2012-10-29.full.json | 1432 ++ apis/datapipeline-2012-10-29.paginators.json | 26 + apis/directconnect-2012-10-25.api.json | 505 + apis/directconnect-2012-10-25.full.json | 1174 + apis/directconnect-2012-10-25.paginators.json | 22 + apis/dynamodb-2011-12-05.api.json | 662 + apis/dynamodb-2011-12-05.full.json | 1208 + apis/dynamodb-2011-12-05.paginators.json | 26 + apis/dynamodb-2011-12-05.waiters.json | 27 + apis/dynamodb-2012-08-10.api.json | 963 + apis/dynamodb-2012-08-10.full.json | 1987 ++ apis/dynamodb-2012-08-10.paginators.json | 26 + apis/dynamodb-2012-08-10.waiters.json | 25 + apis/ec2-2014-06-15.api.json | 12839 +++++++++++ apis/ec2-2014-06-15.full.json | 18153 ++++++++++++++++ apis/ec2-2014-06-15.paginators.json | 112 + apis/ec2-2014-06-15.waiters.json | 146 + apis/elasticache-2014-07-15.api.json | 1383 ++ apis/elasticache-2014-07-15.full.json | 4826 ++++ apis/elasticache-2014-07-15.paginators.json | 76 + apis/elasticbeanstalk-2010-12-01.api.json | 896 + apis/elasticbeanstalk-2010-12-01.full.json | 2445 +++ ...lasticbeanstalk-2010-12-01.paginators.json | 25 + apis/elasticloadbalancing-2012-06-01.api.json | 962 + .../elasticloadbalancing-2012-06-01.full.json | 2904 +++ ...icloadbalancing-2012-06-01.paginators.json | 18 + apis/elasticmapreduce-2009-03-31.api.json | 965 + apis/elasticmapreduce-2009-03-31.full.json | 2282 ++ ...lasticmapreduce-2009-03-31.paginators.json | 32 + apis/elastictranscoder-2012-09-25.api.json | 871 + apis/elastictranscoder-2012-09-25.full.json | 2477 +++ ...astictranscoder-2012-09-25.paginators.json | 24 + .../elastictranscoder-2012-09-25.waiters.json | 16 + apis/email-2010-12-01.api.json | 499 + apis/email-2010-12-01.full.json | 958 + apis/email-2010-12-01.paginators.json | 13 + apis/email-2010-12-01.waiters.json | 14 + apis/glacier-2012-06-01.api.json | 846 + apis/glacier-2012-06-01.full.json | 2012 ++ apis/glacier-2012-06-01.paginators.json | 28 + apis/glacier-2012-06-01.waiters.json | 23 + apis/iam-2010-05-08.api.json | 1801 ++ apis/iam-2010-05-08.full.json | 5322 +++++ apis/iam-2010-05-08.paginators.json | 119 + apis/importexport-2010-06-01.api.json | 181 + apis/importexport-2010-06-01.full.json | 687 + apis/importexport-2010-06-01.paginators.json | 11 + apis/kinesis-2013-12-02.api.json | 342 + apis/kinesis-2013-12-02.full.json | 1041 + apis/kinesis-2013-12-02.paginators.json | 18 + apis/logs-2014-03-28.api.json | 386 + apis/logs-2014-03-28.full.json | 935 + apis/logs-2014-03-28.paginators.json | 28 + apis/metadata.json | 124 + apis/monitoring-2010-08-01.api.json | 500 + apis/monitoring-2010-08-01.full.json | 1338 ++ apis/monitoring-2010-08-01.paginators.json | 24 + apis/opsworks-2013-02-18.api.json | 1826 ++ apis/opsworks-2013-02-18.full.json | 4404 ++++ apis/opsworks-2013-02-18.paginators.json | 49 + apis/rds-2013-01-10.api.json | 1920 ++ apis/rds-2013-01-10.full.json | 6074 ++++++ apis/rds-2013-01-10.paginators.json | 97 + apis/rds-2013-02-12.api.json | 2052 ++ apis/rds-2013-02-12.full.json | 6392 ++++++ apis/rds-2013-02-12.paginators.json | 110 + apis/rds-2013-09-09.api.json | 2158 ++ apis/rds-2013-09-09.full.json | 6564 ++++++ apis/rds-2013-09-09.paginators.json | 110 + apis/rds-2013-09-09.waiters.json | 36 + apis/redshift-2012-12-01.api.json | 1876 ++ apis/redshift-2012-12-01.full.json | 6318 ++++++ apis/redshift-2012-12-01.paginators.json | 94 + apis/redshift-2012-12-01.waiters.json | 43 + apis/route53-2013-04-01.api.json | 1144 + apis/route53-2013-04-01.full.json | 2493 +++ apis/route53-2013-04-01.paginators.json | 33 + apis/route53domains-2014-05-15.api.json | 512 + apis/route53domains-2014-05-15.full.json | 1622 ++ apis/s3-2006-03-01.api.json | 2905 +++ apis/s3-2006-03-01.full.json | 4199 ++++ apis/s3-2006-03-01.paginators.json | 57 + apis/s3-2006-03-01.waiters.json | 32 + apis/sdb-2009-04-15.api.json | 336 + apis/sdb-2009-04-15.full.json | 1203 + apis/sdb-2009-04-15.paginators.json | 15 + apis/sdb-c2j.diff | 52 + apis/sns-2010-03-31.api.json | 527 + apis/sns-2010-03-31.full.json | 2275 ++ apis/sns-2010-03-31.paginators.json | 29 + apis/sqs-2012-11-05.api.json | 571 + apis/sqs-2012-11-05.full.json | 1438 ++ apis/sqs-2012-11-05.paginators.json | 7 + apis/storagegateway-2013-06-30.api.json | 1257 ++ apis/storagegateway-2013-06-30.full.json | 3153 +++ .../storagegateway-2013-06-30.paginators.json | 52 + apis/sts-2011-06-15.api.json | 233 + apis/sts-2011-06-15.full.json | 786 + apis/support-2013-04-15.api.json | 569 + apis/support-2013-04-15.full.json | 1379 ++ apis/support-2013-04-15.paginators.json | 25 + apis/swf-2012-01-25.api.json | 2072 ++ apis/swf-2012-01-25.full.json | 4463 ++++ apis/swf-2012-01-25.paginators.json | 46 + dist-tools/strategies/default.js | 2 +- doc-src/templates/api-versions/plugin.rb | 4 +- lib/api_loader.js | 131 + lib/aws.js | 3 + lib/core.js | 7 +- lib/service.js | 3 +- lib/services.js | 2 +- package.json | 1 - scripts/lib/translator.js | 153 + scripts/translate-api | 19 + tasks/apis.rake | 8 +- tasks/browser.rake | 1 - 143 files changed, 174306 insertions(+), 14 deletions(-) create mode 100644 apis/autoscaling-2011-01-01.api.json create mode 100644 apis/autoscaling-2011-01-01.full.json create mode 100644 apis/autoscaling-2011-01-01.paginators.json create mode 100644 apis/cloudformation-2010-05-15.api.json create mode 100644 apis/cloudformation-2010-05-15.full.json create mode 100644 apis/cloudformation-2010-05-15.paginators.json create mode 100644 apis/cloudfront-2014-05-31.api.json create mode 100644 apis/cloudfront-2014-05-31.full.json create mode 100644 apis/cloudfront-2014-05-31.paginators.json create mode 100644 apis/cloudfront-2014-05-31.waiters.json create mode 100644 apis/cloudsearch-2011-02-01.api.json create mode 100644 apis/cloudsearch-2011-02-01.full.json create mode 100644 apis/cloudsearch-2011-02-01.paginators.json create mode 100644 apis/cloudsearch-2013-01-01.api.json create mode 100644 apis/cloudsearch-2013-01-01.full.json create mode 100644 apis/cloudsearch-2013-01-01.paginators.json create mode 100644 apis/cloudsearchdomain-2013-01-01.api.json create mode 100644 apis/cloudsearchdomain-2013-01-01.full.json create mode 100644 apis/cloudtrail-2013-11-01.api.json create mode 100644 apis/cloudtrail-2013-11-01.full.json create mode 100644 apis/cloudtrail-2013-11-01.paginators.json create mode 100644 apis/cognito-identity-2014-06-30.api.json create mode 100644 apis/cognito-identity-2014-06-30.full.json create mode 100644 apis/cognito-sync-2014-06-30.api.json create mode 100644 apis/cognito-sync-2014-06-30.full.json create mode 100644 apis/datapipeline-2012-10-29.api.json create mode 100644 apis/datapipeline-2012-10-29.full.json create mode 100644 apis/datapipeline-2012-10-29.paginators.json create mode 100644 apis/directconnect-2012-10-25.api.json create mode 100644 apis/directconnect-2012-10-25.full.json create mode 100644 apis/directconnect-2012-10-25.paginators.json create mode 100644 apis/dynamodb-2011-12-05.api.json create mode 100644 apis/dynamodb-2011-12-05.full.json create mode 100644 apis/dynamodb-2011-12-05.paginators.json create mode 100644 apis/dynamodb-2011-12-05.waiters.json create mode 100644 apis/dynamodb-2012-08-10.api.json create mode 100644 apis/dynamodb-2012-08-10.full.json create mode 100644 apis/dynamodb-2012-08-10.paginators.json create mode 100644 apis/dynamodb-2012-08-10.waiters.json create mode 100644 apis/ec2-2014-06-15.api.json create mode 100644 apis/ec2-2014-06-15.full.json create mode 100644 apis/ec2-2014-06-15.paginators.json create mode 100644 apis/ec2-2014-06-15.waiters.json create mode 100644 apis/elasticache-2014-07-15.api.json create mode 100644 apis/elasticache-2014-07-15.full.json create mode 100644 apis/elasticache-2014-07-15.paginators.json create mode 100644 apis/elasticbeanstalk-2010-12-01.api.json create mode 100644 apis/elasticbeanstalk-2010-12-01.full.json create mode 100644 apis/elasticbeanstalk-2010-12-01.paginators.json create mode 100644 apis/elasticloadbalancing-2012-06-01.api.json create mode 100644 apis/elasticloadbalancing-2012-06-01.full.json create mode 100644 apis/elasticloadbalancing-2012-06-01.paginators.json create mode 100644 apis/elasticmapreduce-2009-03-31.api.json create mode 100644 apis/elasticmapreduce-2009-03-31.full.json create mode 100644 apis/elasticmapreduce-2009-03-31.paginators.json create mode 100644 apis/elastictranscoder-2012-09-25.api.json create mode 100644 apis/elastictranscoder-2012-09-25.full.json create mode 100644 apis/elastictranscoder-2012-09-25.paginators.json create mode 100644 apis/elastictranscoder-2012-09-25.waiters.json create mode 100644 apis/email-2010-12-01.api.json create mode 100644 apis/email-2010-12-01.full.json create mode 100644 apis/email-2010-12-01.paginators.json create mode 100644 apis/email-2010-12-01.waiters.json create mode 100644 apis/glacier-2012-06-01.api.json create mode 100644 apis/glacier-2012-06-01.full.json create mode 100644 apis/glacier-2012-06-01.paginators.json create mode 100644 apis/glacier-2012-06-01.waiters.json create mode 100644 apis/iam-2010-05-08.api.json create mode 100644 apis/iam-2010-05-08.full.json create mode 100644 apis/iam-2010-05-08.paginators.json create mode 100644 apis/importexport-2010-06-01.api.json create mode 100644 apis/importexport-2010-06-01.full.json create mode 100644 apis/importexport-2010-06-01.paginators.json create mode 100644 apis/kinesis-2013-12-02.api.json create mode 100644 apis/kinesis-2013-12-02.full.json create mode 100644 apis/kinesis-2013-12-02.paginators.json create mode 100644 apis/logs-2014-03-28.api.json create mode 100644 apis/logs-2014-03-28.full.json create mode 100644 apis/logs-2014-03-28.paginators.json create mode 100644 apis/metadata.json create mode 100644 apis/monitoring-2010-08-01.api.json create mode 100644 apis/monitoring-2010-08-01.full.json create mode 100644 apis/monitoring-2010-08-01.paginators.json create mode 100644 apis/opsworks-2013-02-18.api.json create mode 100644 apis/opsworks-2013-02-18.full.json create mode 100644 apis/opsworks-2013-02-18.paginators.json create mode 100644 apis/rds-2013-01-10.api.json create mode 100644 apis/rds-2013-01-10.full.json create mode 100644 apis/rds-2013-01-10.paginators.json create mode 100644 apis/rds-2013-02-12.api.json create mode 100644 apis/rds-2013-02-12.full.json create mode 100644 apis/rds-2013-02-12.paginators.json create mode 100644 apis/rds-2013-09-09.api.json create mode 100644 apis/rds-2013-09-09.full.json create mode 100644 apis/rds-2013-09-09.paginators.json create mode 100644 apis/rds-2013-09-09.waiters.json create mode 100644 apis/redshift-2012-12-01.api.json create mode 100644 apis/redshift-2012-12-01.full.json create mode 100644 apis/redshift-2012-12-01.paginators.json create mode 100644 apis/redshift-2012-12-01.waiters.json create mode 100644 apis/route53-2013-04-01.api.json create mode 100644 apis/route53-2013-04-01.full.json create mode 100644 apis/route53-2013-04-01.paginators.json create mode 100644 apis/route53domains-2014-05-15.api.json create mode 100644 apis/route53domains-2014-05-15.full.json create mode 100644 apis/s3-2006-03-01.api.json create mode 100644 apis/s3-2006-03-01.full.json create mode 100644 apis/s3-2006-03-01.paginators.json create mode 100644 apis/s3-2006-03-01.waiters.json create mode 100644 apis/sdb-2009-04-15.api.json create mode 100644 apis/sdb-2009-04-15.full.json create mode 100644 apis/sdb-2009-04-15.paginators.json create mode 100644 apis/sdb-c2j.diff create mode 100644 apis/sns-2010-03-31.api.json create mode 100644 apis/sns-2010-03-31.full.json create mode 100644 apis/sns-2010-03-31.paginators.json create mode 100644 apis/sqs-2012-11-05.api.json create mode 100644 apis/sqs-2012-11-05.full.json create mode 100644 apis/sqs-2012-11-05.paginators.json create mode 100644 apis/storagegateway-2013-06-30.api.json create mode 100644 apis/storagegateway-2013-06-30.full.json create mode 100644 apis/storagegateway-2013-06-30.paginators.json create mode 100644 apis/sts-2011-06-15.api.json create mode 100644 apis/sts-2011-06-15.full.json create mode 100644 apis/support-2013-04-15.api.json create mode 100644 apis/support-2013-04-15.full.json create mode 100644 apis/support-2013-04-15.paginators.json create mode 100644 apis/swf-2012-01-25.api.json create mode 100644 apis/swf-2012-01-25.full.json create mode 100644 apis/swf-2012-01-25.paginators.json create mode 100644 lib/api_loader.js create mode 100644 scripts/lib/translator.js create mode 100755 scripts/translate-api diff --git a/.npmignore b/.npmignore index 1f9c0270bd..974088a651 100644 --- a/.npmignore +++ b/.npmignore @@ -2,7 +2,7 @@ .eslintrc .travis.yml .gitignore -apis/source +apis/*.full.json configuration configuration.sample coverage diff --git a/apis/autoscaling-2011-01-01.api.json b/apis/autoscaling-2011-01-01.api.json new file mode 100644 index 0000000000..e2fc25ce12 --- /dev/null +++ b/apis/autoscaling-2011-01-01.api.json @@ -0,0 +1,1336 @@ +{ + "metadata": { + "apiVersion": "2011-01-01", + "endpointPrefix": "autoscaling", + "serviceFullName": "Auto Scaling", + "signatureVersion": "v4", + "xmlNamespace": "http://autoscaling.amazonaws.com/doc/2011-01-01/", + "protocol": "query" + }, + "operations": { + "AttachInstances": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {} + } + } + }, + "CompleteLifecycleAction": { + "input": { + "type": "structure", + "required": [ + "LifecycleHookName", + "AutoScalingGroupName", + "LifecycleActionToken", + "LifecycleActionResult" + ], + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {}, + "LifecycleActionToken": {}, + "LifecycleActionResult": {} + } + }, + "output": { + "resultWrapper": "CompleteLifecycleActionResult", + "type": "structure", + "members": {} + } + }, + "CreateAutoScalingGroup": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "MinSize", + "MaxSize" + ], + "members": { + "AutoScalingGroupName": {}, + "LaunchConfigurationName": {}, + "InstanceId": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + }, + "DefaultCooldown": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "Sg" + }, + "LoadBalancerNames": { + "shape": "Sh" + }, + "HealthCheckType": {}, + "HealthCheckGracePeriod": { + "type": "integer" + }, + "PlacementGroup": {}, + "VPCZoneIdentifier": {}, + "TerminationPolicies": { + "shape": "Sk" + }, + "Tags": { + "shape": "Sm" + } + } + } + }, + "CreateLaunchConfiguration": { + "input": { + "type": "structure", + "required": [ + "LaunchConfigurationName" + ], + "members": { + "LaunchConfigurationName": {}, + "ImageId": {}, + "KeyName": {}, + "SecurityGroups": { + "shape": "St" + }, + "UserData": {}, + "InstanceId": {}, + "InstanceType": {}, + "KernelId": {}, + "RamdiskId": {}, + "BlockDeviceMappings": { + "shape": "Sv" + }, + "InstanceMonitoring": { + "shape": "S13" + }, + "SpotPrice": {}, + "IamInstanceProfile": {}, + "EbsOptimized": { + "type": "boolean" + }, + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "PlacementTenancy": {} + } + } + }, + "CreateOrUpdateTags": { + "input": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "Sm" + } + } + } + }, + "DeleteAutoScalingGroup": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "ForceDelete": { + "type": "boolean" + } + } + } + }, + "DeleteLaunchConfiguration": { + "input": { + "type": "structure", + "required": [ + "LaunchConfigurationName" + ], + "members": { + "LaunchConfigurationName": {} + } + } + }, + "DeleteLifecycleHook": { + "input": { + "type": "structure", + "required": [ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {} + } + }, + "output": { + "resultWrapper": "DeleteLifecycleHookResult", + "type": "structure", + "members": {} + } + }, + "DeleteNotificationConfiguration": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "TopicARN" + ], + "members": { + "AutoScalingGroupName": {}, + "TopicARN": {} + } + } + }, + "DeletePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyName" + ], + "members": { + "AutoScalingGroupName": {}, + "PolicyName": {} + } + } + }, + "DeleteScheduledAction": { + "input": { + "type": "structure", + "required": [ + "ScheduledActionName" + ], + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionName": {} + } + } + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "Tags" + ], + "members": { + "Tags": { + "shape": "Sm" + } + } + } + }, + "DescribeAccountLimits": { + "output": { + "resultWrapper": "DescribeAccountLimitsResult", + "type": "structure", + "members": { + "MaxNumberOfAutoScalingGroups": { + "type": "integer" + }, + "MaxNumberOfLaunchConfigurations": { + "type": "integer" + } + } + } + }, + "DescribeAdjustmentTypes": { + "output": { + "resultWrapper": "DescribeAdjustmentTypesResult", + "type": "structure", + "members": { + "AdjustmentTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AdjustmentType": {} + } + } + } + } + } + }, + "DescribeAutoScalingGroups": { + "input": { + "type": "structure", + "members": { + "AutoScalingGroupNames": { + "shape": "S1q" + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeAutoScalingGroupsResult", + "type": "structure", + "required": [ + "AutoScalingGroups" + ], + "members": { + "AutoScalingGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "LaunchConfigurationName", + "MinSize", + "MaxSize", + "DesiredCapacity", + "DefaultCooldown", + "AvailabilityZones", + "HealthCheckType", + "CreatedTime" + ], + "members": { + "AutoScalingGroupName": {}, + "AutoScalingGroupARN": {}, + "LaunchConfigurationName": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + }, + "DefaultCooldown": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "Sg" + }, + "LoadBalancerNames": { + "shape": "Sh" + }, + "HealthCheckType": {}, + "HealthCheckGracePeriod": { + "type": "integer" + }, + "Instances": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceId", + "AvailabilityZone", + "LifecycleState", + "HealthStatus", + "LaunchConfigurationName" + ], + "members": { + "InstanceId": {}, + "AvailabilityZone": {}, + "LifecycleState": {}, + "HealthStatus": {}, + "LaunchConfigurationName": {} + } + } + }, + "CreatedTime": { + "type": "timestamp" + }, + "SuspendedProcesses": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ProcessName": {}, + "SuspensionReason": {} + } + } + }, + "PlacementGroup": {}, + "VPCZoneIdentifier": {}, + "EnabledMetrics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Metric": {}, + "Granularity": {} + } + } + }, + "Status": {}, + "Tags": { + "shape": "S23" + }, + "TerminationPolicies": { + "shape": "Sk" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAutoScalingInstances": { + "input": { + "type": "structure", + "members": { + "InstanceIds": { + "shape": "S2" + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeAutoScalingInstancesResult", + "type": "structure", + "members": { + "AutoScalingInstances": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceId", + "AutoScalingGroupName", + "AvailabilityZone", + "LifecycleState", + "HealthStatus", + "LaunchConfigurationName" + ], + "members": { + "InstanceId": {}, + "AutoScalingGroupName": {}, + "AvailabilityZone": {}, + "LifecycleState": {}, + "HealthStatus": {}, + "LaunchConfigurationName": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAutoScalingNotificationTypes": { + "output": { + "resultWrapper": "DescribeAutoScalingNotificationTypesResult", + "type": "structure", + "members": { + "AutoScalingNotificationTypes": { + "shape": "S2a" + } + } + } + }, + "DescribeLaunchConfigurations": { + "input": { + "type": "structure", + "members": { + "LaunchConfigurationNames": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeLaunchConfigurationsResult", + "type": "structure", + "required": [ + "LaunchConfigurations" + ], + "members": { + "LaunchConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LaunchConfigurationName", + "ImageId", + "InstanceType", + "CreatedTime" + ], + "members": { + "LaunchConfigurationName": {}, + "LaunchConfigurationARN": {}, + "ImageId": {}, + "KeyName": {}, + "SecurityGroups": { + "shape": "St" + }, + "UserData": {}, + "InstanceType": {}, + "KernelId": {}, + "RamdiskId": {}, + "BlockDeviceMappings": { + "shape": "Sv" + }, + "InstanceMonitoring": { + "shape": "S13" + }, + "SpotPrice": {}, + "IamInstanceProfile": {}, + "CreatedTime": { + "type": "timestamp" + }, + "EbsOptimized": { + "type": "boolean" + }, + "AssociatePublicIpAddress": { + "type": "boolean" + }, + "PlacementTenancy": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeLifecycleHookTypes": { + "output": { + "resultWrapper": "DescribeLifecycleHookTypesResult", + "type": "structure", + "members": { + "LifecycleHookTypes": { + "shape": "S2a" + } + } + } + }, + "DescribeLifecycleHooks": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "LifecycleHookNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeLifecycleHooksResult", + "type": "structure", + "members": { + "LifecycleHooks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {}, + "LifecycleTransition": {}, + "NotificationTargetARN": {}, + "RoleARN": {}, + "NotificationMetadata": {}, + "HeartbeatTimeout": { + "type": "integer" + }, + "GlobalTimeout": { + "type": "integer" + }, + "DefaultResult": {} + } + } + } + } + } + }, + "DescribeMetricCollectionTypes": { + "output": { + "resultWrapper": "DescribeMetricCollectionTypesResult", + "type": "structure", + "members": { + "Metrics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Metric": {} + } + } + }, + "Granularities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Granularity": {} + } + } + } + } + } + }, + "DescribeNotificationConfigurations": { + "input": { + "type": "structure", + "members": { + "AutoScalingGroupNames": { + "shape": "S1q" + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeNotificationConfigurationsResult", + "type": "structure", + "required": [ + "NotificationConfigurations" + ], + "members": { + "NotificationConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "TopicARN": {}, + "NotificationType": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribePolicies": { + "input": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "PolicyNames": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribePoliciesResult", + "type": "structure", + "members": { + "ScalingPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "PolicyName": {}, + "ScalingAdjustment": { + "type": "integer" + }, + "AdjustmentType": {}, + "Cooldown": { + "type": "integer" + }, + "PolicyARN": {}, + "Alarms": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AlarmName": {}, + "AlarmARN": {} + } + } + }, + "MinAdjustmentStep": { + "type": "integer" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeScalingActivities": { + "input": { + "type": "structure", + "members": { + "ActivityIds": { + "type": "list", + "member": {} + }, + "AutoScalingGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeScalingActivitiesResult", + "type": "structure", + "required": [ + "Activities" + ], + "members": { + "Activities": { + "shape": "S3b" + }, + "NextToken": {} + } + } + }, + "DescribeScalingProcessTypes": { + "output": { + "resultWrapper": "DescribeScalingProcessTypesResult", + "type": "structure", + "members": { + "Processes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ProcessName" + ], + "members": { + "ProcessName": {} + } + } + } + } + } + }, + "DescribeScheduledActions": { + "input": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionNames": { + "type": "list", + "member": {} + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeScheduledActionsResult", + "type": "structure", + "members": { + "ScheduledUpdateGroupActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionName": {}, + "ScheduledActionARN": {}, + "Time": { + "type": "timestamp" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Recurrence": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "members": { + "Filters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Values": { + "type": "list", + "member": {} + } + } + } + }, + "NextToken": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeTagsResult", + "type": "structure", + "members": { + "Tags": { + "shape": "S23" + }, + "NextToken": {} + } + } + }, + "DescribeTerminationPolicyTypes": { + "output": { + "resultWrapper": "DescribeTerminationPolicyTypesResult", + "type": "structure", + "members": { + "TerminationPolicyTypes": { + "shape": "Sk" + } + } + } + }, + "DetachInstances": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ShouldDecrementDesiredCapacity" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {}, + "ShouldDecrementDesiredCapacity": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DetachInstancesResult", + "type": "structure", + "members": { + "Activities": { + "shape": "S3b" + } + } + } + }, + "DisableMetricsCollection": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "Metrics": { + "shape": "S3x" + } + } + } + }, + "EnableMetricsCollection": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "Granularity" + ], + "members": { + "AutoScalingGroupName": {}, + "Metrics": { + "shape": "S3x" + }, + "Granularity": {} + } + } + }, + "EnterStandby": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ShouldDecrementDesiredCapacity" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {}, + "ShouldDecrementDesiredCapacity": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "EnterStandbyResult", + "type": "structure", + "members": { + "Activities": { + "shape": "S3b" + } + } + } + }, + "ExecutePolicy": { + "input": { + "type": "structure", + "required": [ + "PolicyName" + ], + "members": { + "AutoScalingGroupName": {}, + "PolicyName": {}, + "HonorCooldown": { + "type": "boolean" + } + } + } + }, + "ExitStandby": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "InstanceIds": { + "shape": "S2" + }, + "AutoScalingGroupName": {} + } + }, + "output": { + "resultWrapper": "ExitStandbyResult", + "type": "structure", + "members": { + "Activities": { + "shape": "S3b" + } + } + } + }, + "PutLifecycleHook": { + "input": { + "type": "structure", + "required": [ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {}, + "LifecycleTransition": {}, + "RoleARN": {}, + "NotificationTargetARN": {}, + "NotificationMetadata": {}, + "HeartbeatTimeout": { + "type": "integer" + }, + "DefaultResult": {} + } + }, + "output": { + "resultWrapper": "PutLifecycleHookResult", + "type": "structure", + "members": {} + } + }, + "PutNotificationConfiguration": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "TopicARN", + "NotificationTypes" + ], + "members": { + "AutoScalingGroupName": {}, + "TopicARN": {}, + "NotificationTypes": { + "shape": "S2a" + } + } + } + }, + "PutScalingPolicy": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "PolicyName", + "ScalingAdjustment", + "AdjustmentType" + ], + "members": { + "AutoScalingGroupName": {}, + "PolicyName": {}, + "ScalingAdjustment": { + "type": "integer" + }, + "AdjustmentType": {}, + "Cooldown": { + "type": "integer" + }, + "MinAdjustmentStep": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "PutScalingPolicyResult", + "type": "structure", + "members": { + "PolicyARN": {} + } + } + }, + "PutScheduledUpdateGroupAction": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "ScheduledActionName" + ], + "members": { + "AutoScalingGroupName": {}, + "ScheduledActionName": {}, + "Time": { + "type": "timestamp" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Recurrence": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + } + } + } + }, + "RecordLifecycleActionHeartbeat": { + "input": { + "type": "structure", + "required": [ + "LifecycleHookName", + "AutoScalingGroupName", + "LifecycleActionToken" + ], + "members": { + "LifecycleHookName": {}, + "AutoScalingGroupName": {}, + "LifecycleActionToken": {} + } + }, + "output": { + "resultWrapper": "RecordLifecycleActionHeartbeatResult", + "type": "structure", + "members": {} + } + }, + "ResumeProcesses": { + "input": { + "shape": "S4d" + } + }, + "SetDesiredCapacity": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName", + "DesiredCapacity" + ], + "members": { + "AutoScalingGroupName": {}, + "DesiredCapacity": { + "type": "integer" + }, + "HonorCooldown": { + "type": "boolean" + } + } + } + }, + "SetInstanceHealth": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "HealthStatus" + ], + "members": { + "InstanceId": {}, + "HealthStatus": {}, + "ShouldRespectGracePeriod": { + "type": "boolean" + } + } + } + }, + "SuspendProcesses": { + "input": { + "shape": "S4d" + } + }, + "TerminateInstanceInAutoScalingGroup": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "ShouldDecrementDesiredCapacity" + ], + "members": { + "InstanceId": {}, + "ShouldDecrementDesiredCapacity": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "TerminateInstanceInAutoScalingGroupResult", + "type": "structure", + "members": { + "Activity": { + "shape": "S3c" + } + } + } + }, + "UpdateAutoScalingGroup": { + "input": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "LaunchConfigurationName": {}, + "MinSize": { + "type": "integer" + }, + "MaxSize": { + "type": "integer" + }, + "DesiredCapacity": { + "type": "integer" + }, + "DefaultCooldown": { + "type": "integer" + }, + "AvailabilityZones": { + "shape": "Sg" + }, + "HealthCheckType": {}, + "HealthCheckGracePeriod": { + "type": "integer" + }, + "PlacementGroup": {}, + "VPCZoneIdentifier": {}, + "TerminationPolicies": { + "shape": "Sk" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "Sg": { + "type": "list", + "member": {} + }, + "Sh": { + "type": "list", + "member": {} + }, + "Sk": { + "type": "list", + "member": {} + }, + "Sm": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "ResourceId": {}, + "ResourceType": {}, + "Key": {}, + "Value": {}, + "PropagateAtLaunch": { + "type": "boolean" + } + } + } + }, + "St": { + "type": "list", + "member": {} + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DeviceName" + ], + "members": { + "VirtualName": {}, + "DeviceName": {}, + "Ebs": { + "type": "structure", + "members": { + "SnapshotId": {}, + "VolumeSize": { + "type": "integer" + }, + "VolumeType": {}, + "DeleteOnTermination": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + } + } + }, + "NoDevice": { + "type": "boolean" + } + } + } + }, + "S13": { + "type": "structure", + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "S1q": { + "type": "list", + "member": {} + }, + "S23": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ResourceId": {}, + "ResourceType": {}, + "Key": {}, + "Value": {}, + "PropagateAtLaunch": { + "type": "boolean" + } + } + } + }, + "S2a": { + "type": "list", + "member": {} + }, + "S3b": { + "type": "list", + "member": { + "shape": "S3c" + } + }, + "S3c": { + "type": "structure", + "required": [ + "ActivityId", + "AutoScalingGroupName", + "Cause", + "StartTime", + "StatusCode" + ], + "members": { + "ActivityId": {}, + "AutoScalingGroupName": {}, + "Description": {}, + "Cause": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "StatusCode": {}, + "StatusMessage": {}, + "Progress": { + "type": "integer" + }, + "Details": {} + } + }, + "S3x": { + "type": "list", + "member": {} + }, + "S4d": { + "type": "structure", + "required": [ + "AutoScalingGroupName" + ], + "members": { + "AutoScalingGroupName": {}, + "ScalingProcesses": { + "type": "list", + "member": {} + } + } + } + } +} \ No newline at end of file diff --git a/apis/autoscaling-2011-01-01.full.json b/apis/autoscaling-2011-01-01.full.json new file mode 100644 index 0000000000..efd3115b0a --- /dev/null +++ b/apis/autoscaling-2011-01-01.full.json @@ -0,0 +1,3063 @@ +{ + "metadata":{ + "apiVersion":"2011-01-01", + "endpointPrefix":"autoscaling", + "serviceFullName":"Auto Scaling", + "signatureVersion":"v4", + "xmlNamespace":"http://autoscaling.amazonaws.com/doc/2011-01-01/", + "protocol":"query" + }, + "documentation":"Auto Scaling

Auto Scaling is a web service designed to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon EC2) instances based on user-defined policies, schedules, and health checks. This service is used in conjunction with Amazon CloudWatch and Elastic Load Balancing services.

Auto Scaling provides APIs that you can call by submitting a Query Request. Query requests are HTTP or HTTPS requests that use the HTTP verbs GET or POST and a Query parameter named Action or Operation that specifies the API you are calling. Action is used throughout this documentation, although Operation is also supported for backward compatibility with other Amazon Web Services (AWS) Query APIs.

Calling the API using a Query request is the most direct way to access the web service, but requires that your application handle low-level details such as generating the hash to sign the request and error handling. The benefit of calling the service using a Query request is that you are assured of having access to the complete functionality of the API. For information about signing a a query request, see Use Query Requests to Call Auto Scaling APIs

This guide provides detailed information about Auto Scaling actions, data types, parameters, and errors. For detailed information about Auto Scaling features and their associated API actions, go to the Auto Scaling Developer Guide.

This reference is based on the current WSDL, which is available at:

http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl

Endpoints

The examples in this guide assume that your instances are launched in the US East (Northern Virginia) region and use us-east-1 as the endpoint.

You can set up your Auto Scaling infrastructure in other AWS regions. For information about this product's regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

", + "operations":{ + "AttachInstances":{ + "name":"AttachInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInstancesQuery"}, + "documentation":"

Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. After the instance(s) is attached, it becomes a part of the Auto Scaling group.

For more information, see Attach Amazon EC2 Instances to Your Existing Auto Scaling Group in the Auto Scaling Developer Guide.

" + }, + "CompleteLifecycleAction":{ + "name":"CompleteLifecycleAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CompleteLifecycleActionType"}, + "output":{ + "shape":"CompleteLifecycleActionAnswer", + "documentation":"

The output of the CompleteLifecycleAction.

", + "resultWrapper":"CompleteLifecycleActionResult" + }, + "documentation":"

Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
  2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
  3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
  4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
  5. Complete the lifecycle action.

To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.

" + }, + "CreateAutoScalingGroup":{ + "name":"CreateAutoScalingGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateAutoScalingGroupType", + "documentation":"

" + }, + "errors":[ + { + "shape":"AlreadyExistsFault", + "error":{ + "code":"AlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The named Auto Scaling group or launch configuration already exists.

" + }, + { + "shape":"LimitExceededFault", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for capacity groups or launch configurations for this customer has already been reached.

" + } + ], + "documentation":"

Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls.

" + }, + "CreateLaunchConfiguration":{ + "name":"CreateLaunchConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateLaunchConfigurationType", + "documentation":"

" + }, + "errors":[ + { + "shape":"AlreadyExistsFault", + "error":{ + "code":"AlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The named Auto Scaling group or launch configuration already exists.

" + }, + { + "shape":"LimitExceededFault", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for capacity groups or launch configurations for this customer has already been reached.

" + } + ], + "documentation":"

Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use.

" + }, + "CreateOrUpdateTags":{ + "name":"CreateOrUpdateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateOrUpdateTagsType", + "documentation":"

" + }, + "errors":[ + { + "shape":"LimitExceededFault", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for capacity groups or launch configurations for this customer has already been reached.

" + }, + { + "shape":"AlreadyExistsFault", + "error":{ + "code":"AlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The named Auto Scaling group or launch configuration already exists.

" + } + ], + "documentation":"

Creates new tags or updates existing tags for an Auto Scaling group.

For information on creating tags for your Auto Scaling group, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.

" + }, + "DeleteAutoScalingGroup":{ + "name":"DeleteAutoScalingGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteAutoScalingGroupType", + "documentation":"

" + }, + "errors":[ + { + "shape":"ScalingActivityInProgressFault", + "error":{ + "code":"ScalingActivityInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.

" + }, + { + "shape":"ResourceInUseFault", + "error":{ + "code":"ResourceInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used.

" + } + ], + "documentation":"

Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress.

" + }, + "DeleteLaunchConfiguration":{ + "name":"DeleteLaunchConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"LaunchConfigurationNameType", + "documentation":"

" + }, + "errors":[ + { + "shape":"ResourceInUseFault", + "error":{ + "code":"ResourceInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used.

" + } + ], + "documentation":"

Deletes the specified LaunchConfiguration.

The specified launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

" + }, + "DeleteLifecycleHook":{ + "name":"DeleteLifecycleHook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLifecycleHookType"}, + "output":{ + "shape":"DeleteLifecycleHookAnswer", + "documentation":"

The output of the DeleteLifecycleHook action.

", + "resultWrapper":"DeleteLifecycleHookResult" + }, + "documentation":"

Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

" + }, + "DeleteNotificationConfiguration":{ + "name":"DeleteNotificationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteNotificationConfigurationType", + "documentation":"

" + }, + "documentation":"

Deletes notifications created by PutNotificationConfiguration.

" + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeletePolicyType", + "documentation":"

" + }, + "documentation":"

Deletes a policy created by PutScalingPolicy.

" + }, + "DeleteScheduledAction":{ + "name":"DeleteScheduledAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteScheduledActionType", + "documentation":"

" + }, + "documentation":"

Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteTagsType", + "documentation":"

" + }, + "documentation":"

Removes the specified tags or a set of tags from a set of resources.

" + }, + "DescribeAccountLimits":{ + "name":"DescribeAccountLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeAccountLimitsAnswer", + "documentation":"

The output of the DescribeAccountLimitsResult action.

", + "resultWrapper":"DescribeAccountLimitsResult" + }, + "documentation":"

Returns the limits for the Auto Scaling resources currently allowed for your AWS account.

Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of 20 Auto Scaling groups and 100 launch configurations per region.

If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the Support Center and place a request to raise the limits.

" + }, + "DescribeAdjustmentTypes":{ + "name":"DescribeAdjustmentTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeAdjustmentTypesAnswer", + "documentation":"

The output of the DescribeAdjustmentTypes action.

", + "resultWrapper":"DescribeAdjustmentTypesResult" + }, + "documentation":"

Returns policy adjustment types for use in the PutScalingPolicy action.

" + }, + "DescribeAutoScalingGroups":{ + "name":"DescribeAutoScalingGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AutoScalingGroupNamesType", + "documentation":"

The AutoScalingGroupNamesType data type.

" + }, + "output":{ + "shape":"AutoScalingGroupsType", + "documentation":"

The AutoScalingGroupsType data type.

", + "resultWrapper":"DescribeAutoScalingGroupsResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + } + ], + "documentation":"

Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

" + }, + "DescribeAutoScalingInstances":{ + "name":"DescribeAutoScalingInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAutoScalingInstancesType"}, + "output":{ + "shape":"AutoScalingInstancesType", + "documentation":"

The AutoScalingInstancesType data type.

", + "resultWrapper":"DescribeAutoScalingInstancesResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + } + ], + "documentation":"

Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

" + }, + "DescribeAutoScalingNotificationTypes":{ + "name":"DescribeAutoScalingNotificationTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeAutoScalingNotificationTypesAnswer", + "documentation":"

The AutoScalingNotificationTypes data type.

", + "resultWrapper":"DescribeAutoScalingNotificationTypesResult" + }, + "documentation":"

Returns a list of all notification types that are supported by Auto Scaling.

" + }, + "DescribeLaunchConfigurations":{ + "name":"DescribeLaunchConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"LaunchConfigurationNamesType", + "documentation":"

The LaunchConfigurationNamesType data type.

" + }, + "output":{ + "shape":"LaunchConfigurationsType", + "documentation":"

The LaunchConfigurationsType data type.

", + "resultWrapper":"DescribeLaunchConfigurationsResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + } + ], + "documentation":"

Returns a full description of the launch configurations, or the specified launch configurations, if they exist.

If no name is specified, then the full details of all launch configurations are returned.

" + }, + "DescribeLifecycleHookTypes":{ + "name":"DescribeLifecycleHookTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeLifecycleHookTypesAnswer", + "resultWrapper":"DescribeLifecycleHookTypesResult" + }, + "documentation":"

Describes the available types of lifecycle hooks.

" + }, + "DescribeLifecycleHooks":{ + "name":"DescribeLifecycleHooks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLifecycleHooksType"}, + "output":{ + "shape":"DescribeLifecycleHooksAnswer", + "documentation":"

The output of the DescribeLifecycleHooks action.

", + "resultWrapper":"DescribeLifecycleHooksResult" + }, + "documentation":"

Describes the lifecycle hooks that currently belong to the specified Auto Scaling group.

" + }, + "DescribeMetricCollectionTypes":{ + "name":"DescribeMetricCollectionTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeMetricCollectionTypesAnswer", + "documentation":"

The output of the DescribeMetricCollectionTypes action.

", + "resultWrapper":"DescribeMetricCollectionTypesResult" + }, + "documentation":"

Returns a list of metrics and a corresponding list of granularities for each metric.

" + }, + "DescribeNotificationConfigurations":{ + "name":"DescribeNotificationConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNotificationConfigurationsType"}, + "output":{ + "shape":"DescribeNotificationConfigurationsAnswer", + "documentation":"

The output of the DescribeNotificationConfigurations action.

", + "resultWrapper":"DescribeNotificationConfigurationsResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + } + ], + "documentation":"

Returns a list of notification actions associated with Auto Scaling groups for specified events.

" + }, + "DescribePolicies":{ + "name":"DescribePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePoliciesType"}, + "output":{ + "shape":"PoliciesType", + "documentation":"

The PoliciesType data type.

", + "resultWrapper":"DescribePoliciesResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + } + ], + "documentation":"

Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

" + }, + "DescribeScalingActivities":{ + "name":"DescribeScalingActivities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeScalingActivitiesType", + "documentation":"

" + }, + "output":{ + "shape":"ActivitiesType", + "documentation":"

The output for the DescribeScalingActivities action.

", + "resultWrapper":"DescribeScalingActivitiesResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + } + ], + "documentation":"

Returns the scaling activities for the specified Auto Scaling group.

If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list.

This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

" + }, + "DescribeScalingProcessTypes":{ + "name":"DescribeScalingProcessTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"ProcessesType", + "documentation":"

The output of the DescribeScalingProcessTypes action.

", + "resultWrapper":"DescribeScalingProcessTypesResult" + }, + "documentation":"

Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.

" + }, + "DescribeScheduledActions":{ + "name":"DescribeScheduledActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledActionsType"}, + "output":{ + "shape":"ScheduledActionsType", + "documentation":"

A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance.

Starting with API version 2011-01-01, you can use recurrence to specify that a scaling action occurs regularly on a schedule.

", + "resultWrapper":"DescribeScheduledActionsResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + } + ], + "documentation":"

Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in DescribeScalingActivities.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeTagsType", + "documentation":"

" + }, + "output":{ + "shape":"TagsType", + "documentation":"

", + "resultWrapper":"DescribeTagsResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + } + ], + "documentation":"

Lists the Auto Scaling group tags.

You can use filters to limit results when describing tags. For example, you can query for tags of a particular Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all your filters. If there's no match, no special message is returned.

" + }, + "DescribeTerminationPolicyTypes":{ + "name":"DescribeTerminationPolicyTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeTerminationPolicyTypesAnswer", + "documentation":"

The TerminationPolicyTypes data type.

", + "resultWrapper":"DescribeTerminationPolicyTypesResult" + }, + "documentation":"

Returns a list of all termination policies supported by Auto Scaling.

" + }, + "DetachInstances":{ + "name":"DetachInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInstancesQuery"}, + "output":{ + "shape":"DetachInstancesAnswer", + "documentation":"

The output of the DetachInstances action.

", + "resultWrapper":"DetachInstancesResult" + }, + "documentation":"

Using DetachInstances, you can remove an instance from an Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.

To learn more about detaching instances, see Detach Amazon EC2 Instances From Your Auto Scaling Group.

" + }, + "DisableMetricsCollection":{ + "name":"DisableMetricsCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableMetricsCollectionQuery"}, + "documentation":"

Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of affected metrics with the Metrics parameter.

" + }, + "EnableMetricsCollection":{ + "name":"EnableMetricsCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableMetricsCollectionQuery"}, + "documentation":"

Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of enabled metrics with the Metrics parameter.

Auto Scaling metrics collection can be turned on only if the InstanceMonitoring flag, in the Auto Scaling group's launch configuration, is set to True.

" + }, + "EnterStandby":{ + "name":"EnterStandby", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnterStandbyQuery"}, + "output":{ + "shape":"EnterStandbyAnswer", + "documentation":"

The output of the EnterStandby action.

", + "resultWrapper":"EnterStandbyResult" + }, + "documentation":"

Move instances in an Auto Scaling group into a Standby mode.

To learn more about how to put instances into a Standby mode, see Auto Scaling InService State.

" + }, + "ExecutePolicy":{ + "name":"ExecutePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExecutePolicyType"}, + "errors":[ + { + "shape":"ScalingActivityInProgressFault", + "error":{ + "code":"ScalingActivityInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.

" + } + ], + "documentation":"

Executes the specified policy.

" + }, + "ExitStandby":{ + "name":"ExitStandby", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExitStandbyQuery"}, + "output":{ + "shape":"ExitStandbyAnswer", + "documentation":"

The output of the ExitStandby action.

", + "resultWrapper":"ExitStandbyResult" + }, + "documentation":"

Move an instance out of Standby mode.

To learn more about how to put instances that are in a Standby mode back into service, see Auto Scaling InService State.

" + }, + "PutLifecycleHook":{ + "name":"PutLifecycleHook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLifecycleHookType"}, + "output":{ + "shape":"PutLifecycleHookAnswer", + "documentation":"

The output of the PutLifecycleHook action.

", + "resultWrapper":"PutLifecycleHookResult" + }, + "errors":[ + { + "shape":"LimitExceededFault", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for capacity groups or launch configurations for this customer has already been reached.

" + } + ], + "documentation":"

Creates or updates a lifecycle hook for an Auto Scaling Group.

A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
  2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
  3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
  4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
  5. Complete the lifecycle action.

To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.

" + }, + "PutNotificationConfiguration":{ + "name":"PutNotificationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutNotificationConfigurationType"}, + "errors":[ + { + "shape":"LimitExceededFault", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for capacity groups or launch configurations for this customer has already been reached.

" + } + ], + "documentation":"

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.

For more information see Get Email Notifications When Your Auto Scaling Group Changes

A new PutNotificationConfiguration overwrites an existing configuration.

" + }, + "PutScalingPolicy":{ + "name":"PutScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutScalingPolicyType"}, + "output":{ + "shape":"PolicyARNType", + "documentation":"

The PolicyARNType data type.

", + "resultWrapper":"PutScalingPolicyResult" + }, + "errors":[ + { + "shape":"LimitExceededFault", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for capacity groups or launch configurations for this customer has already been reached.

" + } + ], + "documentation":"

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

" + }, + "PutScheduledUpdateGroupAction":{ + "name":"PutScheduledUpdateGroupAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutScheduledUpdateGroupActionType"}, + "errors":[ + { + "shape":"AlreadyExistsFault", + "error":{ + "code":"AlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The named Auto Scaling group or launch configuration already exists.

" + }, + { + "shape":"LimitExceededFault", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for capacity groups or launch configurations for this customer has already been reached.

" + } + ], + "documentation":"

Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.

For information on creating or updating a scheduled action for your Auto Scaling group, see Scale Based on a Schedule.

" + }, + "RecordLifecycleActionHeartbeat":{ + "name":"RecordLifecycleActionHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RecordLifecycleActionHeartbeatType"}, + "output":{ + "shape":"RecordLifecycleActionHeartbeatAnswer", + "documentation":"

The output of the RecordLifecycleActionHeartbeat action.

", + "resultWrapper":"RecordLifecycleActionHeartbeatResult" + }, + "documentation":"

Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter of the PutLifecycleHook operation.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
  2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
  3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
  4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
  5. Complete the lifecycle action.

To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.

" + }, + "ResumeProcesses":{ + "name":"ResumeProcesses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScalingProcessQuery"}, + "documentation":"

Resumes all suspended Auto Scaling processes for an Auto Scaling group. For information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process.

" + }, + "SetDesiredCapacity":{ + "name":"SetDesiredCapacity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetDesiredCapacityType", + "documentation":"

" + }, + "errors":[ + { + "shape":"ScalingActivityInProgressFault", + "error":{ + "code":"ScalingActivityInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.

" + } + ], + "documentation":"

Sets the desired size of the specified AutoScalingGroup.

" + }, + "SetInstanceHealth":{ + "name":"SetInstanceHealth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetInstanceHealthQuery"}, + "documentation":"

Sets the health status of a specified instance that belongs to any of your Auto Scaling groups.

For more information, see Configure Health Checks for Your Auto Scaling group.

" + }, + "SuspendProcesses":{ + "name":"SuspendProcesses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScalingProcessQuery"}, + "documentation":"

Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.

Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses For more information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process.

" + }, + "TerminateInstanceInAutoScalingGroup":{ + "name":"TerminateInstanceInAutoScalingGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"TerminateInstanceInAutoScalingGroupType", + "documentation":"

" + }, + "output":{ + "shape":"ActivityType", + "documentation":"

The output for the TerminateInstanceInAutoScalingGroup action.

", + "resultWrapper":"TerminateInstanceInAutoScalingGroupResult" + }, + "errors":[ + { + "shape":"ScalingActivityInProgressFault", + "error":{ + "code":"ScalingActivityInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.

" + } + ], + "documentation":"

Terminates the specified instance. Optionally, the desired group size can be adjusted.

" + }, + "UpdateAutoScalingGroup":{ + "name":"UpdateAutoScalingGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateAutoScalingGroupType", + "documentation":"

" + }, + "errors":[ + { + "shape":"ScalingActivityInProgressFault", + "error":{ + "code":"ScalingActivityInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.

" + } + ], + "documentation":"

Updates the configuration for the specified AutoScalingGroup.

The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.

" + } + }, + "shapes":{ + "Activities":{ + "type":"list", + "member":{"shape":"Activity"} + }, + "ActivitiesType":{ + "type":"structure", + "required":["Activities"], + "members":{ + "Activities":{ + "shape":"Activities", + "documentation":"

A list of the requested scaling activities.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

Acts as a paging mechanism for large result sets. Set to a non-empty string if there are additional results waiting to be returned. Pass this in to subsequent calls to return additional results.

" + } + }, + "documentation":"

The output for the DescribeScalingActivities action.

" + }, + "Activity":{ + "type":"structure", + "required":[ + "ActivityId", + "AutoScalingGroupName", + "Cause", + "StartTime", + "StatusCode" + ], + "members":{ + "ActivityId":{ + "shape":"XmlString", + "documentation":"

Specifies the ID of the activity.

" + }, + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group.

" + }, + "Description":{ + "shape":"XmlString", + "documentation":"

Contains a friendly, more verbose description of the scaling activity.

" + }, + "Cause":{ + "shape":"XmlStringMaxLen1023", + "documentation":"

Contains the reason the activity was begun.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

Provides the start time of this activity.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

Provides the end time of this activity.

" + }, + "StatusCode":{ + "shape":"ScalingActivityStatusCode", + "documentation":"

Contains the current status of the activity.

" + }, + "StatusMessage":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Contains a friendly, more verbose description of the activity status.

" + }, + "Progress":{ + "shape":"Progress", + "documentation":"

Specifies a value between 0 and 100 that indicates the progress of the activity.

" + }, + "Details":{ + "shape":"XmlString", + "documentation":"

Contains details of the scaling activity.

" + } + }, + "documentation":"

A scaling Activity is a long-running process that represents a change to your AutoScalingGroup, such as changing the size of the group. It can also be a process to replace an instance, or a process to perform any other long-running operations supported by the API.

" + }, + "ActivityIds":{ + "type":"list", + "member":{"shape":"XmlString"} + }, + "ActivityType":{ + "type":"structure", + "members":{ + "Activity":{ + "shape":"Activity", + "documentation":"

A scaling Activity.

" + } + }, + "documentation":"

The output for the TerminateInstanceInAutoScalingGroup action.

" + }, + "AdjustmentType":{ + "type":"structure", + "members":{ + "AdjustmentType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

A policy adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

" + } + }, + "documentation":"

Specifies whether the PutScalingPolicy ScalingAdjustment parameter is an absolute number or a percentage of the current capacity.

" + }, + "AdjustmentTypes":{ + "type":"list", + "member":{"shape":"AdjustmentType"} + }, + "Alarm":{ + "type":"structure", + "members":{ + "AlarmName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the alarm.

" + }, + "AlarmARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the alarm.

" + } + }, + "documentation":"

The Alarm data type.

" + }, + "Alarms":{ + "type":"list", + "member":{"shape":"Alarm"} + }, + "AlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "error":{ + "code":"AlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The named Auto Scaling group or launch configuration already exists.

" + }, + "AsciiStringMaxLen255":{ + "type":"string", + "min":1, + "max":255, + "pattern":"[A-Za-z0-9\\-_\\/]+" + }, + "AssociatePublicIpAddress":{"type":"boolean"}, + "AttachInstancesQuery":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

One or more IDs of the Amazon EC2 instances to attach to the specified Auto Scaling group. You must specify at least one instance ID.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group to which to attach the specified instance(s).

" + } + } + }, + "AutoScalingGroup":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "LaunchConfigurationName", + "MinSize", + "MaxSize", + "DesiredCapacity", + "DefaultCooldown", + "AvailabilityZones", + "HealthCheckType", + "CreatedTime" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Specifies the name of the group.

" + }, + "AutoScalingGroupARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Auto Scaling group.

" + }, + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Specifies the name of the associated LaunchConfiguration.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

Contains the minimum size of the Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

Contains the maximum size of the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

Specifies the desired capacity for the Auto Scaling group.

" + }, + "DefaultCooldown":{ + "shape":"Cooldown", + "documentation":"

The number of seconds after a scaling activity completes before any further scaling activities can start.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Contains a list of Availability Zones for the group.

" + }, + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

A list of load balancers associated with this Auto Scaling group.

" + }, + "HealthCheckType":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The service of interest for the health status check, either \"EC2\" for Amazon EC2 or \"ELB\" for Elastic Load Balancing.

" + }, + "HealthCheckGracePeriod":{ + "shape":"HealthCheckGracePeriod", + "documentation":"

The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

Provides a summary list of Amazon EC2 instances.

" + }, + "CreatedTime":{ + "shape":"TimestampType", + "documentation":"

Specifies the date and time the Auto Scaling group was created.

" + }, + "SuspendedProcesses":{ + "shape":"SuspendedProcesses", + "documentation":"

Suspended processes associated with this Auto Scaling group.

" + }, + "PlacementGroup":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

" + }, + "VPCZoneIdentifier":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.

" + }, + "EnabledMetrics":{ + "shape":"EnabledMetrics", + "documentation":"

A list of metrics enabled for this Auto Scaling group.

" + }, + "Status":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The current state of the Auto Scaling group when a DeleteAutoScalingGroup action is in progress.

" + }, + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

A list of tags for the Auto Scaling group.

" + }, + "TerminationPolicies":{ + "shape":"TerminationPolicies", + "documentation":"

A standalone termination policy or a list of termination policies for this Auto Scaling group.

" + } + }, + "documentation":"

The AutoScalingGroup data type.

" + }, + "AutoScalingGroupDesiredCapacity":{"type":"integer"}, + "AutoScalingGroupMaxSize":{"type":"integer"}, + "AutoScalingGroupMinSize":{"type":"integer"}, + "AutoScalingGroupNames":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "AutoScalingGroupNamesType":{ + "type":"structure", + "members":{ + "AutoScalingGroupNames":{ + "shape":"AutoScalingGroupNames", + "documentation":"

A list of Auto Scaling group names.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of records to return.

" + } + }, + "documentation":"

The AutoScalingGroupNamesType data type.

" + }, + "AutoScalingGroups":{ + "type":"list", + "member":{"shape":"AutoScalingGroup"} + }, + "AutoScalingGroupsType":{ + "type":"structure", + "required":["AutoScalingGroups"], + "members":{ + "AutoScalingGroups":{ + "shape":"AutoScalingGroups", + "documentation":"

A list of Auto Scaling groups.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + } + }, + "documentation":"

The AutoScalingGroupsType data type.

" + }, + "AutoScalingInstanceDetails":{ + "type":"structure", + "required":[ + "InstanceId", + "AutoScalingGroupName", + "AvailabilityZone", + "LifecycleState", + "HealthStatus", + "LaunchConfigurationName" + ], + "members":{ + "InstanceId":{ + "shape":"XmlStringMaxLen16", + "documentation":"

The instance ID of the Amazon EC2 instance.

" + }, + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group associated with this instance.

" + }, + "AvailabilityZone":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The Availability Zone in which this instance resides.

" + }, + "LifecycleState":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The life cycle state of this instance. for more information, see Instance Lifecycle State in the Auto Scaling Developer Guide.

" + }, + "HealthStatus":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The health status of this instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy. Auto Scaling should terminate and replace it.

" + }, + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The launch configuration associated with this instance.

" + } + }, + "documentation":"

The AutoScalingInstanceDetails data type.

" + }, + "AutoScalingInstances":{ + "type":"list", + "member":{"shape":"AutoScalingInstanceDetails"} + }, + "AutoScalingInstancesType":{ + "type":"structure", + "members":{ + "AutoScalingInstances":{ + "shape":"AutoScalingInstances", + "documentation":"

A list of Auto Scaling instances.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + } + }, + "documentation":"

The AutoScalingInstancesType data type.

" + }, + "AutoScalingNotificationTypes":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "AvailabilityZones":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"}, + "min":1 + }, + "BlockDeviceEbsDeleteOnTermination":{"type":"boolean"}, + "BlockDeviceEbsIops":{ + "type":"integer", + "min":100, + "max":4000 + }, + "BlockDeviceEbsVolumeSize":{ + "type":"integer", + "min":1, + "max":1024 + }, + "BlockDeviceEbsVolumeType":{ + "type":"string", + "min":1, + "max":255 + }, + "BlockDeviceMapping":{ + "type":"structure", + "required":["DeviceName"], + "members":{ + "VirtualName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The virtual name associated with the device.

" + }, + "DeviceName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the device within Amazon EC2 (for example, /dev/sdh or xvdh).

" + }, + "Ebs":{ + "shape":"Ebs", + "documentation":"

The Elastic Block Storage volume information.

" + }, + "NoDevice":{ + "shape":"NoDevice", + "documentation":"

Suppresses the device mapping.

" + } + }, + "documentation":"

The BlockDeviceMapping data type.

" + }, + "BlockDeviceMappings":{ + "type":"list", + "member":{"shape":"BlockDeviceMapping"} + }, + "CompleteLifecycleActionAnswer":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output of the CompleteLifecycleAction.

" + }, + "CompleteLifecycleActionType":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "AutoScalingGroupName", + "LifecycleActionToken", + "LifecycleActionResult" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group to which the lifecycle hook belongs.

" + }, + "LifecycleActionToken":{ + "shape":"LifecycleActionToken", + "documentation":"

A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

" + }, + "LifecycleActionResult":{ + "shape":"LifecycleActionResult", + "documentation":"

The action the Auto Scaling group should take. The value for this parameter can be either CONTINUE or ABANDON.

" + } + } + }, + "Cooldown":{"type":"integer"}, + "CreateAutoScalingGroupType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "MinSize", + "MaxSize" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LaunchConfigurationName":{ + "shape":"ResourceName", + "documentation":"

The name of an existing launch configuration to use to launch new instances. Use this attribute if you want to create an Auto Scaling group using an existing launch configuration instead of an EC2 instance.

" + }, + "InstanceId":{ + "shape":"XmlStringMaxLen16", + "documentation":"

The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this attribute if you want to create an Auto Scaling group using an EC2 instance instead of a launch configuration.

When you use an instance to create an Auto Scaling group, a new launch configuration is first created and then associated with the Auto Scaling group. The new launch configuration derives all its attributes from the instance that is used to create the Auto Scaling group, with the exception of BlockDeviceMapping.

For more information, see Create an Auto Scaling Group Using EC2 Instance in the Auto Scaling Developer Guide.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum size of the Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum size of the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The number of Amazon EC2 instances that should be running in the group. The desired capacity must be greater than or equal to the minimum size and less than or equal to the maximum size specified for the Auto Scaling group.

" + }, + "DefaultCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, between a successful scaling activity and the succeeding scaling activity.

If a DefaultCooldown period is not specified, Auto Scaling uses the default value of 300 as the default cool down period for the Auto Scaling group. For more information, see Cooldown Period

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

A list of Availability Zones for the Auto Scaling group. This is required unless you have specified subnets.

" + }, + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

A list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account.

For information on using load balancers, see Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.

" + }, + "HealthCheckType":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The service you want the health checks from, Amazon EC2 or Elastic Load Balancer. Valid values are EC2 or ELB.

By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.

" + }, + "HealthCheckGracePeriod":{ + "shape":"HealthCheckGracePeriod", + "documentation":"

Length of time in seconds after a new Amazon EC2 instance comes into service that Auto Scaling starts checking its health. During this time any health check failure for the that instance is ignored.

This is required if you are adding ELB health check. Frequently, new instances need to warm up, briefly, before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to match the expected startup period of your application.

For more information, see Add an Elastic Load Balancing Health Check.

" + }, + "PlacementGroup":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Physical location of an existing cluster placement group into which you want to launch your instances. For information about cluster placement group, see Using Cluster Instances

" + }, + "VPCZoneIdentifier":{ + "shape":"XmlStringMaxLen255", + "documentation":"

A comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).

If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.

For information on launching your Auto Scaling group into Amazon VPC subnets, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide .

" + }, + "TerminationPolicies":{ + "shape":"TerminationPolicies", + "documentation":"

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values: key=value, value=value, propagate=true or false. Value and propagate are optional parameters.

For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances in the Auto Scaling Developer Guide.

" + } + }, + "documentation":"

" + }, + "CreateLaunchConfigurationType":{ + "type":"structure", + "required":["LaunchConfigurationName"], + "members":{ + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the launch configuration to create.

" + }, + "ImageId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Unique ID of the Amazon Machine Image (AMI) you want to use to launch your EC2 instances. For information about finding Amazon EC2 AMIs, see Finding a Suitable AMI in the Amazon Elastic Compute Cloud User Guide.

" + }, + "KeyName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Amazon EC2 key pair. For more information, see Getting a Key Pair in the Amazon Elastic Compute Cloud User Guide.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The security groups with which to associate Amazon EC2 or Amazon VPC instances.

If your instances are launched in EC2, you can either specify Amazon EC2 security group names or the security group IDs. For more information about Amazon EC2 security groups, see Using Security Groups in the Amazon Elastic Compute Cloud User Guide.

If your instances are launched within VPC, specify Amazon VPC security group IDs. For more information about Amazon VPC security groups, see Security Groups in the Amazon Virtual Private Cloud User Guide.

" + }, + "UserData":{ + "shape":"XmlStringUserData", + "documentation":"

The user data to make available to the launched Amazon EC2 instances. For more information about Amazon EC2 user data, see User Data Retrieval in the Amazon Elastic Compute Cloud User Guide.

" + }, + "InstanceId":{ + "shape":"XmlStringMaxLen16", + "documentation":"

The ID of the Amazon EC2 instance you want to use to create the launch configuration. Use this attribute if you want the launch configuration to derive its attributes from an EC2 instance.

When you use an instance to create a launch configuration, all you need to specify is the InstanceId. The new launch configuration, by default, derives all the attributes from the specified instance with the exception of BlockDeviceMapping.

If you want to create a launch configuration with BlockDeviceMapping or override any other instance attributes, specify them as part of the same request.

For more information on using an InstanceID to create a launch configuration, see Create a Launch Configuration Using an Amazon EC2 Instance in the Auto Scaling Developer Guide.

" + }, + "InstanceType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The instance type of the Amazon EC2 instance. For information about available Amazon EC2 instance types, see Available Instance Types in the Amazon Elastic Cloud Compute User Guide.

" + }, + "KernelId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the kernel associated with the Amazon EC2 AMI.

" + }, + "RamdiskId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the RAM disk associated with the Amazon EC2 AMI.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappings", + "documentation":"

A list of mappings that specify how block devices are exposed to the instance. Each mapping is made up of a VirtualName, a DeviceName, and an ebs data structure that contains information about the associated Elastic Block Storage volume. For more information about Amazon EC2 BlockDeviceMappings, go to Block Device Mapping in the Amazon EC2 product documentation.

" + }, + "InstanceMonitoring":{ + "shape":"InstanceMonitoring", + "documentation":"

Enables detailed monitoring if it is disabled. Detailed monitoring is enabled by default.

When detailed monitoring is enabled, Amazon Cloudwatch will generate metrics every minute and your account will be charged a fee. When you disable detailed monitoring, by specifying False, Cloudwatch will generate metrics every 5 minutes. For more information, see Monitor Your Auto Scaling Instances. For information about Amazon CloudWatch, see the Amazon CloudWatch Developer Guide.

" + }, + "SpotPrice":{ + "shape":"SpotPrice", + "documentation":"

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information on launching Spot Instances, see Using Auto Scaling to Launch Spot Instances in the Auto Scaling Developer Guide.

" + }, + "IamInstanceProfile":{ + "shape":"XmlStringMaxLen1600", + "documentation":"

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

Amazon EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your Amazon EC2 instances to securely access other AWS resources. For information on launching EC2 instances with an IAM role, go to Launching Auto Scaling Instances With an IAM Role in the Auto Scaling Developer Guide.

" + }, + "EbsOptimized":{ + "shape":"EbsOptimized", + "documentation":"

Whether the instance is optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization is not available with all instance types. Additional usage charges apply when using an EBS Optimized instance. By default the instance is not optimized for EBS I/O. For information about EBS-optimized instances, go to EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AssociatePublicIpAddress":{ + "shape":"AssociatePublicIpAddress", + "documentation":"

Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). Specifies whether to assign a public IP address to each instance launched in a Amazon VPC. For more information, see Auto Scaling in Amazon Virtual Private Cloud.

Default: If the instance is launched into a default subnet in a default VPC, the default is true. If the instance is launched into a nondefault subnet in a VPC, the default is false. For information about default VPC and VPC platforms, see Supported Platforms.

" + }, + "PlacementTenancy":{ + "shape":"XmlStringMaxLen64", + "documentation":"

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched in a VPC.

You must set the value of this parameter to dedicated if want to launch Dedicated Instances in a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).

If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your Auto Scaling group.

For more information, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.

Valid values: default | dedicated

" + } + }, + "documentation":"

" + }, + "CreateOrUpdateTagsType":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. The resource type and resource ID identify the type and name of resource for which the tag is created. Currently, auto-scaling-group is the only supported resource type. The valid value for the resource ID is groupname.

The PropagateAtLaunch flag defines whether the new tag will be applied to instances launched by the Auto Scaling group. Valid values are true or false. However, instances that are already running will not get the new or updated tag. Likewise, when you modify a tag, the updated version will be applied only to new instances launched by the Auto Scaling group after the change. Running instances that had the previous version of the tag will continue to have the older tag.

When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.

" + } + }, + "documentation":"

" + }, + "DeleteAutoScalingGroupType":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group to delete.

" + }, + "ForceDelete":{ + "shape":"ForceDelete", + "documentation":"

Starting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.

" + } + }, + "documentation":"

" + }, + "DeleteLifecycleHookAnswer":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output of the DeleteLifecycleHook action.

" + }, + "DeleteLifecycleHookType":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group to which the lifecycle hook belongs.

" + } + } + }, + "DeleteNotificationConfigurationType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "TopicARN" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "TopicARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

" + } + }, + "documentation":"

" + }, + "DeletePolicyType":{ + "type":"structure", + "required":["PolicyName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "PolicyName":{ + "shape":"ResourceName", + "documentation":"

The name or PolicyARN of the policy you want to delete.

" + } + }, + "documentation":"

" + }, + "DeleteScheduledActionType":{ + "type":"structure", + "required":["ScheduledActionName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScheduledActionName":{ + "shape":"ResourceName", + "documentation":"

The name of the action you want to delete.

" + } + }, + "documentation":"

" + }, + "DeleteTagsType":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values are: Resource type = auto-scaling-group, Resource ID = AutoScalingGroupName, key=value, value=value, propagate=true or false.

" + } + }, + "documentation":"

" + }, + "DescribeAccountLimitsAnswer":{ + "type":"structure", + "members":{ + "MaxNumberOfAutoScalingGroups":{ + "shape":"MaxNumberOfAutoScalingGroups", + "documentation":"

The maximum number of Auto Scaling groups allowed for your AWS account.

" + }, + "MaxNumberOfLaunchConfigurations":{ + "shape":"MaxNumberOfLaunchConfigurations", + "documentation":"

The maximum number of launch configurations allowed for your AWS account.

" + } + }, + "documentation":"

The output of the DescribeAccountLimitsResult action.

" + }, + "DescribeAdjustmentTypesAnswer":{ + "type":"structure", + "members":{ + "AdjustmentTypes":{ + "shape":"AdjustmentTypes", + "documentation":"

A list of specific policy adjustment types.

" + } + }, + "documentation":"

The output of the DescribeAdjustmentTypes action.

" + }, + "DescribeAutoScalingInstancesType":{ + "type":"structure", + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of Auto Scaling instances to be described with each call.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token returned by a previous call to indicate that there is more data available.

" + } + } + }, + "DescribeAutoScalingNotificationTypesAnswer":{ + "type":"structure", + "members":{ + "AutoScalingNotificationTypes":{ + "shape":"AutoScalingNotificationTypes", + "documentation":"

Returns a list of all notification types supported by Auto Scaling. They are:

" + } + }, + "documentation":"

The AutoScalingNotificationTypes data type.

" + }, + "DescribeLifecycleHookTypesAnswer":{ + "type":"structure", + "members":{ + "LifecycleHookTypes":{ + "shape":"AutoScalingNotificationTypes", + "documentation":"

Returns a list of all notification types supported by Auto Scaling. They are:

" + } + } + }, + "DescribeLifecycleHooksAnswer":{ + "type":"structure", + "members":{ + "LifecycleHooks":{ + "shape":"LifecycleHooks", + "documentation":"

A list describing the lifecycle hooks that belong to the specified Auto Scaling group.

" + } + }, + "documentation":"

The output of the DescribeLifecycleHooks action.

" + }, + "DescribeLifecycleHooksType":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of one or more Auto Scaling groups.

" + }, + "LifecycleHookNames":{ + "shape":"LifecycleHookNames", + "documentation":"

The name of one or more lifecycle hooks.

" + } + } + }, + "DescribeMetricCollectionTypesAnswer":{ + "type":"structure", + "members":{ + "Metrics":{ + "shape":"MetricCollectionTypes", + "documentation":"

The list of Metrics collected. The following metrics are supported:

" + }, + "Granularities":{ + "shape":"MetricGranularityTypes", + "documentation":"

A list of granularities for the listed Metrics.

" + } + }, + "documentation":"

The output of the DescribeMetricCollectionTypes action.

" + }, + "DescribeNotificationConfigurationsAnswer":{ + "type":"structure", + "required":["NotificationConfigurations"], + "members":{ + "NotificationConfigurations":{ + "shape":"NotificationConfigurations", + "documentation":"

The list of notification configurations.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that is used to mark the start of the next batch of returned results for pagination.

" + } + }, + "documentation":"

The output of the DescribeNotificationConfigurations action.

" + }, + "DescribeNotificationConfigurationsType":{ + "type":"structure", + "members":{ + "AutoScalingGroupNames":{ + "shape":"AutoScalingGroupNames", + "documentation":"

The name of the Auto Scaling group.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that is used to mark the start of the next batch of returned results for pagination.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

Maximum number of records to be returned.

" + } + } + }, + "DescribePoliciesType":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

A list of policy names or policy ARNs to be described. If this list is omitted, all policy names are described. If an auto scaling group name is provided, the results are limited to that group. The list of requested policy names cannot contain more than 50 items. If unknown policy names are requested, they are ignored with no error.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that is used to mark the start of the next batch of returned results for pagination.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of policies that will be described with each call.

" + } + } + }, + "DescribeScalingActivitiesType":{ + "type":"structure", + "members":{ + "ActivityIds":{ + "shape":"ActivityIds", + "documentation":"

A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the AutoScalingGroup.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of scaling activities to return.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results for pagination.

" + } + }, + "documentation":"

" + }, + "DescribeScheduledActionsType":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScheduledActionNames":{ + "shape":"ScheduledActionNames", + "documentation":"

A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of scheduled actions to return.

" + } + } + }, + "DescribeTagsType":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"Filters", + "documentation":"

The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of records to return.

" + } + }, + "documentation":"

" + }, + "DescribeTerminationPolicyTypesAnswer":{ + "type":"structure", + "members":{ + "TerminationPolicyTypes":{ + "shape":"TerminationPolicies", + "documentation":"

Termination policies supported by Auto Scaling. They are: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default

" + } + }, + "documentation":"

The TerminationPolicyTypes data type.

" + }, + "DetachInstancesAnswer":{ + "type":"structure", + "members":{ + "Activities":{ + "shape":"Activities", + "documentation":"

A list describing the activities related to detaching the instances from the Auto Scaling group.

" + } + }, + "documentation":"

The output of the DetachInstances action.

" + }, + "DetachInstancesQuery":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ShouldDecrementDesiredCapacity" + ], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group from which to detach instances.

" + }, + "ShouldDecrementDesiredCapacity":{ + "shape":"ShouldDecrementDesiredCapacity", + "documentation":"

Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

" + } + } + }, + "DisableMetricsCollectionQuery":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name or ARN of the Auto Scaling Group.

" + }, + "Metrics":{ + "shape":"Metrics", + "documentation":"

The list of metrics to disable. If no metrics are specified, all metrics are disabled. The following metrics are supported:

" + } + } + }, + "Ebs":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The snapshot ID.

" + }, + "VolumeSize":{ + "shape":"BlockDeviceEbsVolumeSize", + "documentation":"

The volume size, in gigabytes.

Valid values: If the volume type is io1, the minimum size of the volume is 10.

Default: If you're creating the volume from a snapshot, and you don't specify a volume size, the default is the snapshot size.

Required: Required when the volume type is io1.

" + }, + "VolumeType":{ + "shape":"BlockDeviceEbsVolumeType", + "documentation":"

The volume type.

Valid values: standard | io1

Default: standard

" + }, + "DeleteOnTermination":{ + "shape":"BlockDeviceEbsDeleteOnTermination", + "documentation":"

Indicates whether to delete the volume on instance termination.

Default: true

" + }, + "Iops":{ + "shape":"BlockDeviceEbsIops", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports.

The maximum ratio of IOPS to volume size is 30.0

Valid Values: Range is 100 to 4000.

Default: None.

" + } + }, + "documentation":"

The Ebs data type.

" + }, + "EbsOptimized":{"type":"boolean"}, + "EnableMetricsCollectionQuery":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "Granularity" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name or ARN of the Auto Scaling group.

" + }, + "Metrics":{ + "shape":"Metrics", + "documentation":"

The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

" + }, + "Granularity":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The granularity to associate with the metrics to collect. Currently, the only legal granularity is \"1Minute\".

" + } + } + }, + "EnabledMetric":{ + "type":"structure", + "members":{ + "Metric":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the enabled metric.

" + }, + "Granularity":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The granularity of the enabled metric.

" + } + }, + "documentation":"

The EnabledMetric data type.

" + }, + "EnabledMetrics":{ + "type":"list", + "member":{"shape":"EnabledMetric"} + }, + "EnterStandbyAnswer":{ + "type":"structure", + "members":{ + "Activities":{ + "shape":"Activities", + "documentation":"

A list describing the activities related to moving instances into Standby mode.

" + } + }, + "documentation":"

The output of the EnterStandby action.

" + }, + "EnterStandbyQuery":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ShouldDecrementDesiredCapacity" + ], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

The instances to move into Standby mode. You must specify at least one instance ID.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group from which to move instances into Standby mode.

" + }, + "ShouldDecrementDesiredCapacity":{ + "shape":"ShouldDecrementDesiredCapacity", + "documentation":"

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

" + } + } + }, + "ExecutePolicyType":{ + "type":"structure", + "required":["PolicyName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name or the Amazon Resource Name (ARN) of the Auto Scaling group.

" + }, + "PolicyName":{ + "shape":"ResourceName", + "documentation":"

The name or ARN of the policy you want to run.

" + }, + "HonorCooldown":{ + "shape":"HonorCooldown", + "documentation":"

Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.

Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.

For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.

" + } + } + }, + "ExitStandbyAnswer":{ + "type":"structure", + "members":{ + "Activities":{ + "shape":"Activities", + "documentation":"

A list describing the activities related to moving instances out of Standby mode.

" + } + }, + "documentation":"

The output of the ExitStandby action.

" + }, + "ExitStandbyQuery":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

A list of instances to move out of Standby mode. You must specify at least one instance ID.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group from which to move instances out of Standby mode.

" + } + } + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"XmlString", + "documentation":"

The name of the filter. Valid Name values are: \"auto-scaling-group\", \"key\", \"value\", and \"propagate-at-launch\".

" + }, + "Values":{ + "shape":"Values", + "documentation":"

The value of the filter.

" + } + }, + "documentation":"

The Filter data type.

" + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "ForceDelete":{"type":"boolean"}, + "GlobalTimeout":{"type":"integer"}, + "HealthCheckGracePeriod":{"type":"integer"}, + "HeartbeatTimeout":{"type":"integer"}, + "HonorCooldown":{"type":"boolean"}, + "Instance":{ + "type":"structure", + "required":[ + "InstanceId", + "AvailabilityZone", + "LifecycleState", + "HealthStatus", + "LaunchConfigurationName" + ], + "members":{ + "InstanceId":{ + "shape":"XmlStringMaxLen16", + "documentation":"

Specifies the ID of the Amazon EC2 instance.

" + }, + "AvailabilityZone":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Availability Zones associated with this instance.

" + }, + "LifecycleState":{ + "shape":"LifecycleState", + "documentation":"

Contains a description of the current lifecycle state.

" + }, + "HealthStatus":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The instance's health status.

" + }, + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The launch configuration associated with this instance.

" + } + }, + "documentation":"

The Instance data type.

" + }, + "InstanceIds":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen16"} + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"MonitoringEnabled", + "documentation":"

If True, instance monitoring is enabled.

" + } + }, + "documentation":"

The InstanceMonitoring data type.

" + }, + "Instances":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The NextToken value is invalid.

" + }, + "LaunchConfiguration":{ + "type":"structure", + "required":[ + "LaunchConfigurationName", + "ImageId", + "InstanceType", + "CreatedTime" + ], + "members":{ + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Specifies the name of the launch configuration.

" + }, + "LaunchConfigurationARN":{ + "shape":"ResourceName", + "documentation":"

The launch configuration's Amazon Resource Name (ARN).

" + }, + "ImageId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.

" + }, + "KeyName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Provides the name of the Amazon EC2 key pair.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

A description of the security groups to associate with the Amazon EC2 instances.

" + }, + "UserData":{ + "shape":"XmlStringUserData", + "documentation":"

The user data available to the launched Amazon EC2 instances.

" + }, + "InstanceType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Specifies the instance type of the Amazon EC2 instance.

" + }, + "KernelId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Provides the ID of the kernel associated with the Amazon EC2 AMI.

" + }, + "RamdiskId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Provides ID of the RAM disk associated with the Amazon EC2 AMI.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappings", + "documentation":"

Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.

" + }, + "InstanceMonitoring":{ + "shape":"InstanceMonitoring", + "documentation":"

Controls whether instances in this group are launched with detailed monitoring or not.

" + }, + "SpotPrice":{ + "shape":"SpotPrice", + "documentation":"

Specifies the price to bid when launching Spot Instances.

" + }, + "IamInstanceProfile":{ + "shape":"XmlStringMaxLen1600", + "documentation":"

Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

" + }, + "CreatedTime":{ + "shape":"TimestampType", + "documentation":"

Provides the creation date and time for this launch configuration.

" + }, + "EbsOptimized":{ + "shape":"EbsOptimized", + "documentation":"

Specifies whether the instance is optimized for EBS I/O (true) or not (false).

" + }, + "AssociatePublicIpAddress":{ + "shape":"AssociatePublicIpAddress", + "documentation":"

Specifies whether the instance is associated with a public IP address (true) or not (false).

" + }, + "PlacementTenancy":{ + "shape":"XmlStringMaxLen64", + "documentation":"

Specifies the tenancy of the instance. It can be either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and it can only be launched in a VPC.

" + } + }, + "documentation":"

The LaunchConfiguration data type.

" + }, + "LaunchConfigurationNameType":{ + "type":"structure", + "required":["LaunchConfigurationName"], + "members":{ + "LaunchConfigurationName":{ + "shape":"ResourceName", + "documentation":"

The name of the launch configuration.

" + } + }, + "documentation":"

" + }, + "LaunchConfigurationNames":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "LaunchConfigurationNamesType":{ + "type":"structure", + "members":{ + "LaunchConfigurationNames":{ + "shape":"LaunchConfigurationNames", + "documentation":"

A list of launch configuration names.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of launch configurations. The default is 100.

" + } + }, + "documentation":"

The LaunchConfigurationNamesType data type.

" + }, + "LaunchConfigurations":{ + "type":"list", + "member":{"shape":"LaunchConfiguration"} + }, + "LaunchConfigurationsType":{ + "type":"structure", + "required":["LaunchConfigurations"], + "members":{ + "LaunchConfigurations":{ + "shape":"LaunchConfigurations", + "documentation":"

A list of launch configurations.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + } + }, + "documentation":"

The LaunchConfigurationsType data type.

" + }, + "LifecycleActionResult":{"type":"string"}, + "LifecycleActionToken":{ + "type":"string", + "min":36, + "max":36 + }, + "LifecycleHook":{ + "type":"structure", + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle action hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group to which the lifecycle action belongs.

" + }, + "LifecycleTransition":{ + "shape":"LifecycleTransition", + "documentation":"

The Amazon EC2 instance state to which you want to attach the lifecycle hook. See DescribeLifecycleHooks for a list of available lifecycle hook types.

" + }, + "NotificationTargetARN":{ + "shape":"ResourceName", + "documentation":"

The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target will include:

" + }, + "RoleARN":{ + "shape":"ResourceName", + "documentation":"

The ARN of the Amazon IAM role that allows the Auto Scaling group to publish to the specified notification target.

" + }, + "NotificationMetadata":{ + "shape":"XmlStringMaxLen1023", + "documentation":"

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

" + }, + "HeartbeatTimeout":{ + "shape":"HeartbeatTimeout", + "documentation":"

Defines the amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

" + }, + "GlobalTimeout":{ + "shape":"GlobalTimeout", + "documentation":"

The maximum length of time an instance can remain in a Pending:Wait or Terminating:Wait state. Currently, this value is set at 48 hours.

" + }, + "DefaultResult":{ + "shape":"LifecycleActionResult", + "documentation":"

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is CONTINUE.

" + } + }, + "documentation":"

A lifecycle hook tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:

To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.

" + }, + "LifecycleHookNames":{ + "type":"list", + "member":{"shape":"AsciiStringMaxLen255"} + }, + "LifecycleHooks":{ + "type":"list", + "member":{"shape":"LifecycleHook"} + }, + "LifecycleState":{ + "type":"string", + "enum":[ + "Pending", + "Pending:Wait", + "Pending:Proceed", + "Quarantined", + "InService", + "Terminating", + "Terminating:Wait", + "Terminating:Proceed", + "Terminated", + "Detaching", + "Detached", + "EnteringStandby", + "Standby" + ] + }, + "LifecycleTransition":{"type":"string"}, + "LimitExceededFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for capacity groups or launch configurations for this customer has already been reached.

" + }, + "LoadBalancerNames":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "MaxNumberOfAutoScalingGroups":{"type":"integer"}, + "MaxNumberOfLaunchConfigurations":{"type":"integer"}, + "MaxRecords":{"type":"integer"}, + "MetricCollectionType":{ + "type":"structure", + "members":{ + "Metric":{"shape":"XmlStringMaxLen255"} + }, + "documentation":"

The MetricCollectionType data type.

" + }, + "MetricCollectionTypes":{ + "type":"list", + "member":{"shape":"MetricCollectionType"} + }, + "MetricGranularityType":{ + "type":"structure", + "members":{ + "Granularity":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The granularity of a Metric.

" + } + }, + "documentation":"

The MetricGranularityType data type.

" + }, + "MetricGranularityTypes":{ + "type":"list", + "member":{"shape":"MetricGranularityType"} + }, + "Metrics":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "MinAdjustmentStep":{"type":"integer"}, + "MonitoringEnabled":{"type":"boolean"}, + "NoDevice":{"type":"boolean"}, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

Specifies the Auto Scaling group name.

" + }, + "TopicARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

" + }, + "NotificationType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The types of events for an action to start.

" + } + }, + "documentation":"

The NotificationConfiguration data type.

" + }, + "NotificationConfigurations":{ + "type":"list", + "member":{"shape":"NotificationConfiguration"} + }, + "PoliciesType":{ + "type":"structure", + "members":{ + "ScalingPolicies":{ + "shape":"ScalingPolicies", + "documentation":"

A list of scaling policies.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + } + }, + "documentation":"

The PoliciesType data type.

" + }, + "PolicyARNType":{ + "type":"structure", + "members":{ + "PolicyARN":{ + "shape":"ResourceName", + "documentation":"

A policy's Amazon Resource Name (ARN).

" + } + }, + "documentation":"

The PolicyARNType data type.

" + }, + "PolicyIncrement":{"type":"integer"}, + "PolicyNames":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "ProcessNames":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "ProcessType":{ + "type":"structure", + "required":["ProcessName"], + "members":{ + "ProcessName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of a process.

" + } + }, + "documentation":"

There are two primary Auto Scaling process types--Launch and Terminate. The Launch process creates a new Amazon EC2 instance for an Auto Scaling group, and the Terminate process removes an existing Amazon EC2 instance.

The remaining Auto Scaling process types relate to specific Auto Scaling features:

If you suspend Launch or Terminate, all other process types are affected to varying degrees. The following descriptions discuss how each process type is affected by a suspension of Launch or Terminate.

The AddToLoadBalancer process type adds instances to the load balancer when the instances are launched. If you suspend this process, Auto Scaling will launch the instances but will not add them to the load balancer. If you resume the AddToLoadBalancer process, Auto Scaling will also resume adding new instances to the load balancer when they are launched. However, Auto Scaling will not add running instances that were launched while the process was suspended; those instances must be added manually using the the RegisterInstancesWithLoadBalancer call in the Elastic Load Balancing API Reference.

The AlarmNotification process type accepts notifications from Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you suspend the AlarmNotification process type, Auto Scaling will not automatically execute scaling policies that would be triggered by alarms.

Although the AlarmNotification process type is not directly affected by a suspension of Launch or Terminate, alarm notifications are often used to signal that a change in the size of the Auto Scaling group is warranted. If you suspend Launch or Terminate, Auto Scaling might not be able to implement the alarm's associated policy.

The AZRebalance process type seeks to maintain a balanced number of instances across Availability Zones within a Region. If you remove an Availability Zone from your Auto Scaling group or an Availability Zone otherwise becomes unhealthy or unavailable, Auto Scaling launches new instances in an unaffected Availability Zone before terminating the unhealthy or unavailable instances. When the unhealthy Availability Zone returns to a healthy state, Auto Scaling automatically redistributes the application instances evenly across all of the designated Availability Zones.

If you call SuspendProcesses on the launch process type, the AZRebalance process will neither launch new instances nor terminate existing instances. This is because the AZRebalance process terminates existing instances only after launching the replacement instances.

If you call SuspendProcesses on the terminate process type, the AZRebalance process can cause your Auto Scaling group to grow up to ten percent larger than the maximum size. This is because Auto Scaling allows groups to temporarily grow larger than the maximum size during rebalancing activities. If Auto Scaling cannot terminate instances, your Auto Scaling group could remain up to ten percent larger than the maximum size until you resume the terminate process type.

The HealthCheck process type checks the health of the instances. Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing informs Auto Scaling that the instance is unhealthy. The HealthCheck process can override the health status of an instance that you set with SetInstanceHealth.

The ReplaceUnhealthy process type terminates instances that are marked as unhealthy and subsequently creates new instances to replace them. This process calls both of the primary process types--first Terminate and then Launch.

The HealthCheck process type works in conjunction with the ReplaceUnhealthly process type to provide health check functionality. If you suspend either Launch or Terminate, the ReplaceUnhealthy process type will not function properly.

The ScheduledActions process type performs scheduled actions that you create with PutScheduledUpdateGroupAction. Scheduled actions often involve launching new instances or terminating existing instances. If you suspend either Launch or Terminate, your scheduled actions might not function as expected.

" + }, + "Processes":{ + "type":"list", + "member":{"shape":"ProcessType"} + }, + "ProcessesType":{ + "type":"structure", + "members":{ + "Processes":{ + "shape":"Processes", + "documentation":"

A list of ProcessType names.

" + } + }, + "documentation":"

The output of the DescribeScalingProcessTypes action.

" + }, + "Progress":{"type":"integer"}, + "PropagateAtLaunch":{"type":"boolean"}, + "PutLifecycleHookAnswer":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output of the PutLifecycleHook action.

" + }, + "PutLifecycleHookType":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group to which you want to assign the lifecycle hook.

" + }, + "LifecycleTransition":{ + "shape":"LifecycleTransition", + "documentation":"

The Amazon EC2 instance state to which you want to attach the lifecycle hook. See DescribeLifecycleHookTypes for a list of available lifecycle hook types.

" + }, + "RoleARN":{ + "shape":"ResourceName", + "documentation":"

The ARN of the Amazon IAM role that allows the Auto Scaling group to publish to the specified notification target.

" + }, + "NotificationTargetARN":{ + "shape":"ResourceName", + "documentation":"

The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

The notification message sent to the target will include:

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.

" + }, + "NotificationMetadata":{ + "shape":"XmlStringMaxLen1023", + "documentation":"

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

" + }, + "HeartbeatTimeout":{ + "shape":"HeartbeatTimeout", + "documentation":"

Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).

" + }, + "DefaultResult":{ + "shape":"LifecycleActionResult", + "documentation":"

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON.

" + } + } + }, + "PutNotificationConfigurationType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "TopicARN", + "NotificationTypes" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "TopicARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

" + }, + "NotificationTypes":{ + "shape":"AutoScalingNotificationTypes", + "documentation":"

The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.

" + } + } + }, + "PutScalingPolicyType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "PolicyName", + "ScalingAdjustment", + "AdjustmentType" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name or ARN of the Auto Scaling group.

" + }, + "PolicyName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the policy you want to create or update.

" + }, + "ScalingAdjustment":{ + "shape":"PolicyIncrement", + "documentation":"

The number of instances by which to scale. AdjustmentType determines the interpretation of this number (e.g., as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.

" + }, + "AdjustmentType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information about the adjustment types supported by Auto Scaling, see Scale Based on Demand.

" + }, + "Cooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.

For more information, see Cooldown Period

" + }, + "MinAdjustmentStep":{ + "shape":"MinAdjustmentStep", + "documentation":"

Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.

You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.

" + } + } + }, + "PutScheduledUpdateGroupActionType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ScheduledActionName" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name or ARN of the Auto Scaling group.

" + }, + "ScheduledActionName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of this scaling action.

" + }, + "Time":{ + "shape":"TimestampType", + "documentation":"

Time is deprecated.

The time for this action to start. Time is an alias for StartTime and can be specified instead of StartTime, or vice versa. If both Time and StartTime are specified, their values should be identical. Otherwise, PutScheduledUpdateGroupAction will return an error.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The time for this action to start, as in --start-time 2010-06-01T00:00:00Z.

If you try to schedule your action in the past, Auto Scaling returns an error message.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The time for this action to end.

" + }, + "Recurrence":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For information about cron syntax, go to Wikipedia, The Free Encyclopedia.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum size for the new Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum size for the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The number of Amazon EC2 instances that should be running in the group.

" + } + } + }, + "RecordLifecycleActionHeartbeatAnswer":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output of the RecordLifecycleActionHeartbeat action.

" + }, + "RecordLifecycleActionHeartbeatType":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "AutoScalingGroupName", + "LifecycleActionToken" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group to which the hook belongs.

" + }, + "LifecycleActionToken":{ + "shape":"LifecycleActionToken", + "documentation":"

A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

" + } + } + }, + "ResourceInUseFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "error":{ + "code":"ResourceInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used.

" + }, + "ResourceName":{ + "type":"string", + "min":1, + "max":1600, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "ScalingActivityInProgressFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "error":{ + "code":"ScalingActivityInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.

" + }, + "ScalingActivityStatusCode":{ + "type":"string", + "enum":[ + "WaitingForSpotInstanceRequestId", + "WaitingForSpotInstanceId", + "WaitingForInstanceId", + "PreInService", + "InProgress", + "WaitingForELBConnectionDraining", + "MidLifecycleAction", + "Successful", + "Failed", + "Cancelled" + ] + }, + "ScalingPolicies":{ + "type":"list", + "member":{"shape":"ScalingPolicy"} + }, + "ScalingPolicy":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group associated with this scaling policy.

" + }, + "PolicyName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the scaling policy.

" + }, + "ScalingAdjustment":{ + "shape":"PolicyIncrement", + "documentation":"

The number associated with the specified adjustment type. A positive value adds to the current capacity and a negative value removes from the current capacity.

" + }, + "AdjustmentType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

" + }, + "Cooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

" + }, + "PolicyARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the policy.

" + }, + "Alarms":{ + "shape":"Alarms", + "documentation":"

A list of CloudWatch Alarms related to the policy.

" + }, + "MinAdjustmentStep":{ + "shape":"MinAdjustmentStep", + "documentation":"

Changes the DesiredCapacity of the Auto Scaling group by at least the specified number of instances.

" + } + }, + "documentation":"

The ScalingPolicy data type.

" + }, + "ScalingProcessQuery":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

" + }, + "ScalingProcesses":{ + "shape":"ProcessNames", + "documentation":"

The processes that you want to suspend or resume, which can include one or more of the following:

To suspend all process types, omit this parameter.

" + } + } + }, + "ScheduledActionNames":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "ScheduledActionsType":{ + "type":"structure", + "members":{ + "ScheduledUpdateGroupActions":{ + "shape":"ScheduledUpdateGroupActions", + "documentation":"

A list of scheduled actions designed to update an Auto Scaling group.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that marks the start of the next batch of returned results.

" + } + }, + "documentation":"

A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance.

Starting with API version 2011-01-01, you can use recurrence to specify that a scaling action occurs regularly on a schedule.

" + }, + "ScheduledUpdateGroupAction":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group to be updated.

" + }, + "ScheduledActionName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of this scheduled action.

" + }, + "ScheduledActionARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of this scheduled action.

" + }, + "Time":{ + "shape":"TimestampType", + "documentation":"

Time is deprecated.

The time that the action is scheduled to begin. Time is an alias for StartTime.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The time that the action is scheduled to begin. This value can be up to one month in the future.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The time that the action is scheduled to end. This value can be up to one month in the future.

" + }, + "Recurrence":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The regular schedule that an action occurs.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum size of the Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum size of the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The number of instances you prefer to maintain in your Auto Scaling group.

" + } + }, + "documentation":"

This data type stores information about a scheduled update to an Auto Scaling group.

" + }, + "ScheduledUpdateGroupActions":{ + "type":"list", + "member":{"shape":"ScheduledUpdateGroupAction"} + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"XmlString"} + }, + "SetDesiredCapacityType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "DesiredCapacity" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The new capacity setting for the Auto Scaling group.

" + }, + "HonorCooldown":{ + "shape":"HonorCooldown", + "documentation":"

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to the new capacity setting.

" + } + }, + "documentation":"

" + }, + "SetInstanceHealthQuery":{ + "type":"structure", + "required":[ + "InstanceId", + "HealthStatus" + ], + "members":{ + "InstanceId":{ + "shape":"XmlStringMaxLen16", + "documentation":"

The identifier of the Amazon EC2 instance.

" + }, + "HealthStatus":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.

" + }, + "ShouldRespectGracePeriod":{ + "shape":"ShouldRespectGracePeriod", + "documentation":"

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.

For more information, see the HealthCheckGracePeriod parameter description in the CreateAutoScalingGroup action.

" + } + } + }, + "ShouldDecrementDesiredCapacity":{"type":"boolean"}, + "ShouldRespectGracePeriod":{"type":"boolean"}, + "SpotPrice":{ + "type":"string", + "min":1, + "max":255 + }, + "SuspendedProcess":{ + "type":"structure", + "members":{ + "ProcessName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the suspended process.

" + }, + "SuspensionReason":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The reason that the process was suspended.

" + } + }, + "documentation":"

An Auto Scaling process that has been suspended. For more information, see ProcessType.

" + }, + "SuspendedProcesses":{ + "type":"list", + "member":{"shape":"SuspendedProcess"} + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "ResourceId":{ + "shape":"XmlString", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ResourceType":{ + "shape":"XmlString", + "documentation":"

The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.

" + }, + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + }, + "PropagateAtLaunch":{ + "shape":"PropagateAtLaunch", + "documentation":"

Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.

" + } + }, + "documentation":"

The tag applied to an Auto Scaling group.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"XmlString", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ResourceType":{ + "shape":"XmlString", + "documentation":"

The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.

" + }, + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + }, + "PropagateAtLaunch":{ + "shape":"PropagateAtLaunch", + "documentation":"

Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.

" + } + }, + "documentation":"

The tag applied to an Auto Scaling group.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{"shape":"TagDescription"} + }, + "TagKey":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "TagValue":{ + "type":"string", + "min":0, + "max":256, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagsType":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

The list of tags.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string used to mark the start of the next batch of returned results.

" + } + }, + "documentation":"

" + }, + "TerminateInstanceInAutoScalingGroupType":{ + "type":"structure", + "required":[ + "InstanceId", + "ShouldDecrementDesiredCapacity" + ], + "members":{ + "InstanceId":{ + "shape":"XmlStringMaxLen16", + "documentation":"

The ID of the Amazon EC2 instance to be terminated.

" + }, + "ShouldDecrementDesiredCapacity":{ + "shape":"ShouldDecrementDesiredCapacity", + "documentation":"

Specifies whether (true) or not (false) terminating this instance should also decrement the size of the AutoScalingGroup.

" + } + }, + "documentation":"

" + }, + "TerminationPolicies":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen1600"} + }, + "TimestampType":{"type":"timestamp"}, + "UpdateAutoScalingGroupType":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LaunchConfigurationName":{ + "shape":"ResourceName", + "documentation":"

The name of the launch configuration.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum size of the Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum size of the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The desired capacity for the Auto Scaling group.

" + }, + "DefaultCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes before any further scaling activities can start. For more information, see Cooldown Period.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Availability Zones for the group.

" + }, + "HealthCheckType":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The type of health check for the instances in the Auto Scaling group. The health check type can either be EC2 for Amazon EC2 or ELB for Elastic Load Balancing.

" + }, + "HealthCheckGracePeriod":{ + "shape":"HealthCheckGracePeriod", + "documentation":"

The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when the instance passes System Status and the Instance Status checks from Amazon EC2. For more information, see DescribeInstanceStatus.

" + }, + "PlacementGroup":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

" + }, + "VPCZoneIdentifier":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.

For more information on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the the Auto Scaling Developer Guide.

" + }, + "TerminationPolicies":{ + "shape":"TerminationPolicies", + "documentation":"

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.

" + } + }, + "documentation":"

" + }, + "Values":{ + "type":"list", + "member":{"shape":"XmlString"} + }, + "XmlString":{ + "type":"string", + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen1023":{ + "type":"string", + "min":1, + "max":1023, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen16":{ + "type":"string", + "min":1, + "max":16, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen1600":{ + "type":"string", + "min":1, + "max":1600, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen255":{ + "type":"string", + "min":1, + "max":255, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen32":{ + "type":"string", + "min":1, + "max":32, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen64":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringUserData":{ + "type":"string", + "max":21847, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + } + } +} diff --git a/apis/autoscaling-2011-01-01.paginators.json b/apis/autoscaling-2011-01-01.paginators.json new file mode 100644 index 0000000000..31bc094456 --- /dev/null +++ b/apis/autoscaling-2011-01-01.paginators.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "DescribeAutoScalingGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "AutoScalingGroups" + }, + "DescribeAutoScalingInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "AutoScalingInstances" + }, + "DescribeLaunchConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "LaunchConfigurations" + }, + "DescribeNotificationConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "NotificationConfigurations" + }, + "DescribePolicies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "ScalingPolicies" + }, + "DescribeScalingActivities": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "Activities" + }, + "DescribeScheduledActions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "ScheduledUpdateGroupActions" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "Tags" + } + } +} diff --git a/apis/cloudformation-2010-05-15.api.json b/apis/cloudformation-2010-05-15.api.json new file mode 100644 index 0000000000..3ff8740eae --- /dev/null +++ b/apis/cloudformation-2010-05-15.api.json @@ -0,0 +1,527 @@ +{ + "metadata": { + "apiVersion": "2010-05-15", + "endpointPrefix": "cloudformation", + "serviceFullName": "AWS CloudFormation", + "signatureVersion": "v4", + "xmlNamespace": "http://cloudformation.amazonaws.com/doc/2010-05-15/", + "protocol": "query" + }, + "operations": { + "CancelUpdateStack": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {} + } + } + }, + "CreateStack": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "TemplateBody": {}, + "TemplateURL": {}, + "Parameters": { + "shape": "S6" + }, + "DisableRollback": { + "type": "boolean" + }, + "TimeoutInMinutes": { + "type": "integer" + }, + "NotificationARNs": { + "shape": "Sd" + }, + "Capabilities": { + "shape": "Sf" + }, + "OnFailure": {}, + "StackPolicyBody": {}, + "StackPolicyURL": {}, + "Tags": { + "shape": "Sk" + } + } + }, + "output": { + "resultWrapper": "CreateStackResult", + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "DeleteStack": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {} + } + } + }, + "DescribeStackEvents": { + "input": { + "type": "structure", + "members": { + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeStackEventsResult", + "type": "structure", + "members": { + "StackEvents": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StackId", + "EventId", + "StackName", + "Timestamp" + ], + "members": { + "StackId": {}, + "EventId": {}, + "StackName": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "Timestamp": { + "type": "timestamp" + }, + "ResourceStatus": {}, + "ResourceStatusReason": {}, + "ResourceProperties": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeStackResource": { + "input": { + "type": "structure", + "required": [ + "StackName", + "LogicalResourceId" + ], + "members": { + "StackName": {}, + "LogicalResourceId": {} + } + }, + "output": { + "resultWrapper": "DescribeStackResourceResult", + "type": "structure", + "members": { + "StackResourceDetail": { + "type": "structure", + "required": [ + "LogicalResourceId", + "ResourceType", + "LastUpdatedTimestamp", + "ResourceStatus" + ], + "members": { + "StackName": {}, + "StackId": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "LastUpdatedTimestamp": { + "type": "timestamp" + }, + "ResourceStatus": {}, + "ResourceStatusReason": {}, + "Description": {}, + "Metadata": {} + } + } + } + } + }, + "DescribeStackResources": { + "input": { + "type": "structure", + "members": { + "StackName": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {} + } + }, + "output": { + "resultWrapper": "DescribeStackResourcesResult", + "type": "structure", + "members": { + "StackResources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LogicalResourceId", + "ResourceType", + "Timestamp", + "ResourceStatus" + ], + "members": { + "StackName": {}, + "StackId": {}, + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "Timestamp": { + "type": "timestamp" + }, + "ResourceStatus": {}, + "ResourceStatusReason": {}, + "Description": {} + } + } + } + } + } + }, + "DescribeStacks": { + "input": { + "type": "structure", + "members": { + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeStacksResult", + "type": "structure", + "members": { + "Stacks": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StackName", + "CreationTime", + "StackStatus" + ], + "members": { + "StackId": {}, + "StackName": {}, + "Description": {}, + "Parameters": { + "shape": "S6" + }, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + }, + "StackStatus": {}, + "StackStatusReason": {}, + "DisableRollback": { + "type": "boolean" + }, + "NotificationARNs": { + "shape": "Sd" + }, + "TimeoutInMinutes": { + "type": "integer" + }, + "Capabilities": { + "shape": "Sf" + }, + "Outputs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "OutputKey": {}, + "OutputValue": {}, + "Description": {} + } + } + }, + "Tags": { + "shape": "Sk" + } + } + } + }, + "NextToken": {} + } + } + }, + "EstimateTemplateCost": { + "input": { + "type": "structure", + "members": { + "TemplateBody": {}, + "TemplateURL": {}, + "Parameters": { + "shape": "S6" + } + } + }, + "output": { + "resultWrapper": "EstimateTemplateCostResult", + "type": "structure", + "members": { + "Url": {} + } + } + }, + "GetStackPolicy": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {} + } + }, + "output": { + "resultWrapper": "GetStackPolicyResult", + "type": "structure", + "members": { + "StackPolicyBody": {} + } + } + }, + "GetTemplate": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {} + } + }, + "output": { + "resultWrapper": "GetTemplateResult", + "type": "structure", + "members": { + "TemplateBody": {} + } + } + }, + "ListStackResources": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListStackResourcesResult", + "type": "structure", + "members": { + "StackResourceSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "LogicalResourceId", + "ResourceType", + "LastUpdatedTimestamp", + "ResourceStatus" + ], + "members": { + "LogicalResourceId": {}, + "PhysicalResourceId": {}, + "ResourceType": {}, + "LastUpdatedTimestamp": { + "type": "timestamp" + }, + "ResourceStatus": {}, + "ResourceStatusReason": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListStacks": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "StackStatusFilter": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "ListStacksResult", + "type": "structure", + "members": { + "StackSummaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StackName", + "CreationTime", + "StackStatus" + ], + "members": { + "StackId": {}, + "StackName": {}, + "TemplateDescription": {}, + "CreationTime": { + "type": "timestamp" + }, + "LastUpdatedTime": { + "type": "timestamp" + }, + "DeletionTime": { + "type": "timestamp" + }, + "StackStatus": {}, + "StackStatusReason": {} + } + } + }, + "NextToken": {} + } + } + }, + "SetStackPolicy": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "StackPolicyBody": {}, + "StackPolicyURL": {} + } + } + }, + "UpdateStack": { + "input": { + "type": "structure", + "required": [ + "StackName" + ], + "members": { + "StackName": {}, + "TemplateBody": {}, + "TemplateURL": {}, + "UsePreviousTemplate": { + "type": "boolean" + }, + "StackPolicyDuringUpdateBody": {}, + "StackPolicyDuringUpdateURL": {}, + "Parameters": { + "shape": "S6" + }, + "Capabilities": { + "shape": "Sf" + }, + "StackPolicyBody": {}, + "StackPolicyURL": {}, + "NotificationARNs": { + "shape": "Sd" + } + } + }, + "output": { + "resultWrapper": "UpdateStackResult", + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "ValidateTemplate": { + "input": { + "type": "structure", + "members": { + "TemplateBody": {}, + "TemplateURL": {} + } + }, + "output": { + "resultWrapper": "ValidateTemplateResult", + "type": "structure", + "members": { + "Parameters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterKey": {}, + "DefaultValue": {}, + "NoEcho": { + "type": "boolean" + }, + "Description": {} + } + } + }, + "Description": {}, + "Capabilities": { + "shape": "Sf" + }, + "CapabilitiesReason": {} + } + } + } + }, + "shapes": { + "S6": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ParameterKey": {}, + "ParameterValue": {}, + "UsePreviousValue": { + "type": "boolean" + } + } + } + }, + "Sd": { + "type": "list", + "member": {} + }, + "Sf": { + "type": "list", + "member": {} + }, + "Sk": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + } + } +} \ No newline at end of file diff --git a/apis/cloudformation-2010-05-15.full.json b/apis/cloudformation-2010-05-15.full.json new file mode 100644 index 0000000000..ba846c3ea3 --- /dev/null +++ b/apis/cloudformation-2010-05-15.full.json @@ -0,0 +1,1306 @@ +{ + "metadata":{ + "apiVersion":"2010-05-15", + "endpointPrefix":"cloudformation", + "serviceFullName":"AWS CloudFormation", + "signatureVersion":"v4", + "xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/", + "protocol":"query" + }, + "documentation":"AWS CloudFormation\n

AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly.\n AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling\n to build highly-reliable, highly scalable, cost effective applications without worrying about creating and\n configuring the underlying AWS infrastructure.

\n

With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all\n member resources of the stack together and manages all dependencies between the resources for you.

\n

For more information about this product, go to the CloudFormation Product Page.

\n

Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a\n specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

", + "operations":{ + "CancelUpdateStack":{ + "name":"CancelUpdateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CancelUpdateStackInput", + "documentation":"

The input for CancelUpdateStack action.

" + }, + "documentation":"

Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the\n update and revert to the previous stack configuration.

\n Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=CancelUpdateStack\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n " + }, + "CreateStack":{ + "name":"CreateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateStackInput", + "documentation":"

The input for CreateStack action.

" + }, + "output":{ + "shape":"CreateStackOutput", + "documentation":"

The output for a CreateStack action.

", + "resultWrapper":"CreateStackResult" + }, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceededException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Quota for the resource has already been reached.

" + }, + { + "shape":"AlreadyExistsException", + "error":{ + "code":"AlreadyExistsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Resource with the name requested already exists.

" + }, + { + "shape":"InsufficientCapabilitiesException", + "error":{ + "code":"InsufficientCapabilitiesException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The template contains resources with capabilities that were not specified in the Capabilities parameter.

" + } + ], + "documentation":"

Creates a stack as specified in the template. After the call completes successfully, the stack creation\n starts. You can check the status of the stack via the DescribeStacks API.

\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=CreateStack\n &StackName=MyStack\n &TemplateBody=[Template Document]\n &NotificationARNs.member.1=arn:aws:sns:us-east-1:1234567890:my-topic\n &Parameters.member.1.ParameterKey=AvailabilityZone\n &Parameters.member.1.ParameterValue=us-east-1a\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n\n " + }, + "DeleteStack":{ + "name":"DeleteStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteStackInput", + "documentation":"

The input for DeleteStack action.

" + }, + "documentation":"

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not\n show up in the DescribeStacks API if the deletion has been completed successfully.

\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DeleteStack\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n " + }, + "DescribeStackEvents":{ + "name":"DescribeStackEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeStackEventsInput", + "documentation":"

The input for DescribeStackEvents action.

" + }, + "output":{ + "shape":"DescribeStackEventsOutput", + "documentation":"

The output for a DescribeStackEvents action.

", + "resultWrapper":"DescribeStackEventsResult" + }, + "documentation":"

Returns all stack related events for a specified stack. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.

\n You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStackEvents\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n Event-1-Id\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyStack\n MyStack_One\n AWS::CloudFormation::Stack\n 2010-07-27T22:26:28Z\n CREATE_IN_PROGRESS\n User initiated\n \n \n Event-2-Id\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyDBInstance\n MyStack_DB1\n AWS::SecurityGroup\n 2010-07-27T22:27:28Z\n CREATE_IN_PROGRESS\n {\"GroupDescription\":...}\n \n \n Event-3-Id\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MySG1\n MyStack_SG1\n AWS:: SecurityGroup\n 2010-07-27T22:28:28Z\n CREATE_COMPLETE\n \n \n\n " + }, + "DescribeStackResource":{ + "name":"DescribeStackResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeStackResourceInput", + "documentation":"

The input for DescribeStackResource action.

" + }, + "output":{ + "shape":"DescribeStackResourceOutput", + "documentation":"

The output for a DescribeStackResource action.

", + "resultWrapper":"DescribeStackResourceResult" + }, + "documentation":"

Returns a description of the specified resource in the specified stack.

\n

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has\n been deleted.

\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStackResource\n &StackName=MyStack\n &LogicalResourceId=MyDBInstance\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2011-07-08T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyDBInstance\n MyStack_DB1\n AWS::RDS::DBInstance\n 2011-07-07T22:27:28Z\n CREATE_COMPLETE\n \n \n\n " + }, + "DescribeStackResources":{ + "name":"DescribeStackResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeStackResourcesInput", + "documentation":"

The input for DescribeStackResources action.

" + }, + "output":{ + "shape":"DescribeStackResourcesOutput", + "documentation":"

The output for a DescribeStackResources action.

", + "resultWrapper":"DescribeStackResourcesResult" + }, + "documentation":"

Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all\n the associated resources that are part of the stack are returned. If PhysicalResourceId is\n specified, the associated resources of the stack that the resource belongs to are returned.

\n\n Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.\n\n

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after\n the stack has been deleted.

\n\n

You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about\n resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.

\n\n A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStackResources\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyDBInstance\n MyStack_DB1\n AWS::DBInstance\n 2010-07-27T22:27:28Z\n CREATE_COMPLETE\n \n \n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyAutoScalingGroup\n MyStack_ASG1\n AWS::AutoScalingGroup\n 2010-07-27T22:28:28Z\n CREATE_IN_PROGRESS\n \n \n\n " + }, + "DescribeStacks":{ + "name":"DescribeStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeStacksInput", + "documentation":"

The input for DescribeStacks action.

" + }, + "output":{ + "shape":"DescribeStacksOutput", + "documentation":"

The output for a DescribeStacks action.

", + "resultWrapper":"DescribeStacksResult" + }, + "documentation":"

Returns the description for the specified stack; if no stack name was specified, then it returns the\n description for all the stacks created.

\n \n\n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStacks\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n \n \n MyStack\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n 2010-07-27T22:28:28Z\n CREATE_COMPLETE\n false\n \n \n StartPage\n http://my-load-balancer.amazonaws.com:80/index.html\n \n \n \n \n\n " + }, + "EstimateTemplateCost":{ + "name":"EstimateTemplateCost", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EstimateTemplateCostInput"}, + "output":{ + "shape":"EstimateTemplateCostOutput", + "documentation":"

The output for a EstimateTemplateCost action.

", + "resultWrapper":"EstimateTemplateCostResult" + }, + "documentation":"

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with\n a query string that describes the resources required to run the template.

\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=EstimateTemplateCost\n &TemplateURL= https://s3.amazonaws.com/cloudformation-samples-us-east-1/Drupal_Simple.template\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2011-12-04T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n http://calculator.s3.amazonaws.com/calc5.html?key=cf-2e351785-e821-450c-9d58-625e1e1ebfb6\n\n " + }, + "GetStackPolicy":{ + "name":"GetStackPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetStackPolicyInput", + "documentation":"

The input for the GetStackPolicy action.

" + }, + "output":{ + "shape":"GetStackPolicyOutput", + "documentation":"

The output for the GetStackPolicy action.

", + "resultWrapper":"GetStackPolicyResult" + }, + "documentation":"

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=GetStackPolicy\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n \"{\n \"Statement\" : [\n {\n \"Effect\" : \"Deny\",\n \"Action\" : \"Update:*\",\n \"Principal\" : \"*\",\n \"Resource\" : \"LogicalResourceId/ProductionDatabase\"\n },\n {\n \"Effect\" : \"Allow\",\n \"Action\" : \"Update:*\",\n \"Principal\" : \"*\",\n \"Resource\" : \"*\"\n }\n ]\n }\n\n " + }, + "GetTemplate":{ + "name":"GetTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetTemplateInput", + "documentation":"

The input for a GetTemplate action.

" + }, + "output":{ + "shape":"GetTemplateOutput", + "documentation":"

The output for GetTemplate action.

", + "resultWrapper":"GetTemplateResult" + }, + "documentation":"

Returns the template body for a specified stack. You can get the template for running or deleted\n stacks.

\n

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

\n If the template does not exist, a ValidationError is returned. \n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=GetTemplate\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \"{\n \"AWSTemplateFormatVersion\" : \"2010-09-09\",\n \"Description\" : \"Simple example\",\n \"Resources\" : {\n \"MySQS\" : {\n \"Type\" : \"AWS::SQS::Queue\",\n \"Properties\" : {\n }\n }\n }\n}\n\n " + }, + "ListStackResources":{ + "name":"ListStackResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListStackResourcesInput", + "documentation":"

The input for ListStackResource action.

" + }, + "output":{ + "shape":"ListStackResourcesOutput", + "documentation":"

The output for a ListStackResources action.

", + "resultWrapper":"ListStackResourcesResult" + }, + "documentation":"

Returns descriptions of all resources of the specified stack.

\n

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been\n deleted.

\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=ListStackResources\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2011-07-08T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n \n CREATE_COMPLETE\n DBSecurityGroup\n 2011-06-21T20:15:58Z\n gmarcteststack-dbsecuritygroup-1s5m0ez5lkk6w\n AWS::RDS::DBSecurityGroup\n \n \n CREATE_COMPLETE\n SampleDB\n 2011-06-21T20:25:57Z\n MyStack-sampledb-ycwhk1v830lx\n AWS::RDS::DBInstance\n \n \n CREATE_COMPLETE\n SampleApplication\n 2011-06-21T20:26:12Z\n MyStack-SampleApplication-1MKNASYR3RBQL\n AWS::ElasticBeanstalk::Application\n \n \n CREATE_COMPLETE\n SampleEnvironment\n 2011-06-21T20:28:48Z\n myst-Samp-1AGU6ERZX6M3Q\n AWS::ElasticBeanstalk::Environment\n \n \n CREATE_COMPLETE\n AlarmTopic\n 2011-06-21T20:29:06Z\n arn:aws:sns:us-east-1:803981987763:MyStack-Al\narmTopic-SW4IQELG7RPJ\n AWS::SNS::Topic\n \n \n CREATE_COMPLETE\n CPUAlarmHigh\n 2011-06-21T20:29:23Z\n MyStack-CPUAlarmHigh-POBWQPDJA81F\n AWS::CloudWatch::Alarm\n \n \n \n \n 2d06e36c-ac1d-11e0-a958-f9382b6eb86b\n \n\n\n " + }, + "ListStacks":{ + "name":"ListStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListStacksInput", + "documentation":"

The input for ListStacks action.

" + }, + "output":{ + "shape":"ListStacksOutput", + "documentation":"

The output for ListStacks action.

", + "resultWrapper":"ListStacksResult" + }, + "documentation":"

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary\n information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no\n StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and\n stacks that have been deleted).

\n \n\n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=ListStacks\n &StackStatusFilter.member.1=CREATE_IN_PROGRESS\n &StackStatusFilter.member.2=DELETE_COMPLETE\n &Version=2010-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n \n \n \n \n arn:aws:cloudformation:us-east-1:1234567:stack/TestCreate1/aaaaa\n \n CREATE_IN_PROGRESS\n vpc1\n 2011-05-23T15:47:44Z\n \n Creates one EC2 instance and a load balancer.\n \n \n \n \n arn:aws:cloudformation:us-east-1:1234567:stack/TestDelete2/bbbbb\n \n DELETE_COMPLETE\n 2011-03-10T16:20:51Z\n WP1\n 2011-03-05T19:57:58Z\n \n A simple basic Cloudformation Template.\n \n \n \n \n\n " + }, + "SetStackPolicy":{ + "name":"SetStackPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetStackPolicyInput", + "documentation":"

The input for the SetStackPolicy action.

" + }, + "documentation":"

Sets a stack policy for a specified stack.

\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=SetStackPolicy\n &StackName=MyStack\n &StackPolicyBody=[Stack Policy Document]\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n " + }, + "UpdateStack":{ + "name":"UpdateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateStackInput", + "documentation":"

The input for UpdateStack action.

" + }, + "output":{ + "shape":"UpdateStackOutput", + "documentation":"

The output for a UpdateStack action.

", + "resultWrapper":"UpdateStackResult" + }, + "errors":[ + { + "shape":"InsufficientCapabilitiesException", + "error":{ + "code":"InsufficientCapabilitiesException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The template contains resources with capabilities that were not specified in the Capabilities parameter.

" + } + ], + "documentation":"

Updates a stack as specified in the template. After the call completes successfully, the stack update starts.\n You can check the status of the stack via the DescribeStacks action.

\n

To get a copy of the template for an existing stack, you can use the GetTemplate action.

\n

Tags that were associated with this stack during creation time will still be associated with the stack after an\n UpdateStack operation.

\n

For more information about creating an update template, updating a stack, and monitoring the progress of the\n update, see Updating a Stack.

\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=UpdateStack\n &StackName=MyStack\n &TemplateBody=[Template Document]\n &Parameters.member.1.ParameterKey=AvailabilityZone\n &Parameters.member.1.ParameterValue=us-east-1a\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n\n " + }, + "ValidateTemplate":{ + "name":"ValidateTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ValidateTemplateInput", + "documentation":"

The input for ValidateTemplate action.

" + }, + "output":{ + "shape":"ValidateTemplateOutput", + "documentation":"

The output for ValidateTemplate action.

", + "resultWrapper":"ValidateTemplateResult" + }, + "documentation":"

Validates a specified template.

\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=ValidateTemplate\n &TemplateBody=http://myTemplateRepository/TemplateOne.template\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n \n \n false\n InstanceType\n Type of instance to launch\n m1.small\n \n \n false\n WebServerPort\n The TCP port for the Web Server\n 8888\n \n \n false\n KeyName\n Name of an existing EC2 KeyPair to enable SSH access into the server\n \n \n \n \n 0be7b6e8-e4a0-11e0-a5bd-9f8d5a7dbc91\n \n\n\n " + } + }, + "shapes":{ + "AlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AlreadyExistsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Resource with the name requested already exists.

" + }, + "CancelUpdateStackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique identifier associated with the stack.

" + } + }, + "documentation":"

The input for CancelUpdateStack action.

" + }, + "Capabilities":{ + "type":"list", + "member":{"shape":"Capability"} + }, + "CapabilitiesReason":{"type":"string"}, + "Capability":{ + "type":"string", + "enum":["CAPABILITY_IAM"] + }, + "CreateStackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack. The name must be unique within your AWS account.

\n Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length\n of the name is 255 characters." + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes)\n located in an S3 bucket in the same region as the stack. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures that specify input parameters for the stack.

" + }, + "DisableRollback":{ + "shape":"DisableRollback", + "documentation":"

Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.

\n

Default: false\n

" + }, + "TimeoutInMinutes":{ + "shape":"TimeoutMinutes", + "documentation":"

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback\n is not set or is set to false, the stack will be rolled back.

" + }, + "NotificationARNs":{ + "shape":"NotificationARNs", + "documentation":"

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic\n ARNs using the SNS console or your Command Line Interface\n (CLI).

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

The list of capabilities that you want to allow in the stack. If your template contains certain resources, you\n must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an\n InsufficientCapabilities error. The following resources require you to specify the capabilities parameter: AWS::CloudFormation::Stack, AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

" + }, + "OnFailure":{ + "shape":"OnFailure", + "documentation":"

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or\n DELETE. You can specify either OnFailure or DisableRollback, but not both.

\n

Default: ROLLBACK

" + }, + "StackPolicyBody":{ + "shape":"StackPolicyBody", + "documentation":"

Structure containing the stack policy body. For more information, go to \n Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" + }, + "StackPolicyURL":{ + "shape":"StackPolicyURL", + "documentation":"

Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags\n defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of\n 10 tags can be specified.

" + } + }, + "documentation":"

The input for CreateStack action.

" + }, + "CreateStackOutput":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + } + }, + "documentation":"

The output for a CreateStack action.

" + }, + "CreationTime":{"type":"timestamp"}, + "DeleteStackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique identifier associated with the stack.

" + } + }, + "documentation":"

The input for DeleteStack action.

" + }, + "DeletionTime":{"type":"timestamp"}, + "DescribeStackEventsInput":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique identifier associated with the stack, which are not always interchangeable:

\n \n

Default: There is no default value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

String that identifies the start of the next list of events, if there is one.

\n

Default: There is no default value.

" + } + }, + "documentation":"

The input for DescribeStackEvents action.

" + }, + "DescribeStackEventsOutput":{ + "type":"structure", + "members":{ + "StackEvents":{ + "shape":"StackEvents", + "documentation":"

A list of StackEvents structures.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

String that identifies the start of the next list of events, if there is one.

" + } + }, + "documentation":"

The output for a DescribeStackEvents action.

" + }, + "DescribeStackResourceInput":{ + "type":"structure", + "required":[ + "StackName", + "LogicalResourceId" + ], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique identifier associated with the stack, which are not always interchangeable:

\n \n

Default: There is no default value.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource as specified in the template.

\n

Default: There is no default value.

" + } + }, + "documentation":"

The input for DescribeStackResource action.

" + }, + "DescribeStackResourceOutput":{ + "type":"structure", + "members":{ + "StackResourceDetail":{ + "shape":"StackResourceDetail", + "documentation":"

A StackResourceDetail structure containing the description of the specified resource in the\n specified stack.

" + } + }, + "documentation":"

The output for a DescribeStackResource action.

" + }, + "DescribeStackResourcesInput":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique identifier associated with the stack, which are not always interchangeable:

\n \n

Default: There is no default value.

\n

Required: Conditional. If you do not specify StackName, you must specify\n PhysicalResourceId.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource as specified in the template.

\n

Default: There is no default value.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.

\n

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to\n DescribeStackResources to find which stack the instance belongs to and what other resources are\n part of the stack.

\n

Required: Conditional. If you do not specify PhysicalResourceId, you must specify\n StackName.

\n

Default: There is no default value.

" + } + }, + "documentation":"

The input for DescribeStackResources action.

" + }, + "DescribeStackResourcesOutput":{ + "type":"structure", + "members":{ + "StackResources":{ + "shape":"StackResources", + "documentation":"

A list of StackResource structures.

" + } + }, + "documentation":"

The output for a DescribeStackResources action.

" + }, + "DescribeStacksInput":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique identifier associated with the stack, which are not always interchangeable:

\n \n

Default: There is no default value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"String that identifies the start of the next list of stacks, if there is one." + } + }, + "documentation":"

The input for DescribeStacks action.

" + }, + "DescribeStacksOutput":{ + "type":"structure", + "members":{ + "Stacks":{ + "shape":"Stacks", + "documentation":"

A list of stack structures.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"String that identifies the start of the next list of stacks, if there is one." + } + }, + "documentation":"

The output for a DescribeStacks action.

" + }, + "Description":{"type":"string"}, + "DisableRollback":{"type":"boolean"}, + "EstimateTemplateCostInput":{ + "type":"structure", + "members":{ + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.)

\n

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the\n same region as the stack. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures that specify input parameters.

" + } + } + }, + "EstimateTemplateCostOutput":{ + "type":"structure", + "members":{ + "Url":{ + "shape":"Url", + "documentation":"

An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the\n template.

" + } + }, + "documentation":"

The output for a EstimateTemplateCost action.

" + }, + "EventId":{"type":"string"}, + "GetStackPolicyInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or stack ID that is associated with the stack whose policy you want to get.

" + } + }, + "documentation":"

The input for the GetStackPolicy action.

" + }, + "GetStackPolicyOutput":{ + "type":"structure", + "members":{ + "StackPolicyBody":{ + "shape":"StackPolicyBody", + "documentation":"

Structure containing the stack policy body. (For more information, go to \n Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)

" + } + }, + "documentation":"

The output for the GetStackPolicy action.

" + }, + "GetTemplateInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique identifier associated with the stack, which are not always interchangeable:

\n \n

Default: There is no default value.

" + } + }, + "documentation":"

The input for a GetTemplate action.

" + }, + "GetTemplateOutput":{ + "type":"structure", + "members":{ + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body. (For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.)

" + } + }, + "documentation":"

The output for GetTemplate action.

" + }, + "InsufficientCapabilitiesException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientCapabilitiesException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The template contains resources with capabilities that were not specified in the Capabilities parameter.

" + }, + "LastUpdatedTime":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"LimitExceededException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Quota for the resource has already been reached.

" + }, + "ListStackResourcesInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique identifier associated with the stack, which are not always interchangeable:

\n \n

Default: There is no default value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

String that identifies the start of the next list of stack resource summaries, if there is one.

\n

Default: There is no default value.

" + } + }, + "documentation":"

The input for ListStackResource action.

" + }, + "ListStackResourcesOutput":{ + "type":"structure", + "members":{ + "StackResourceSummaries":{ + "shape":"StackResourceSummaries", + "documentation":"

A list of StackResourceSummary structures.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

String that identifies the start of the next list of stack resources, if there is one.

" + } + }, + "documentation":"

The output for a ListStackResources action.

" + }, + "ListStacksInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

String that identifies the start of the next list of stacks, if there is one.

\n

Default: There is no default value.

" + }, + "StackStatusFilter":{ + "shape":"StackStatusFilter", + "documentation":"

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified\n status codes. For a complete list of stack status codes, see the StackStatus parameter of the\n Stack data type.

" + } + }, + "documentation":"

The input for ListStacks action.

" + }, + "ListStacksOutput":{ + "type":"structure", + "members":{ + "StackSummaries":{ + "shape":"StackSummaries", + "documentation":"

A list of StackSummary structures containing information about the specified stacks.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

String that identifies the start of the next list of stacks, if there is one.

" + } + }, + "documentation":"

The output for ListStacks action.

" + }, + "LogicalResourceId":{"type":"string"}, + "Metadata":{"type":"string"}, + "NextToken":{ + "type":"string", + "min":1, + "max":1024 + }, + "NoEcho":{"type":"boolean"}, + "NotificationARN":{"type":"string"}, + "NotificationARNs":{ + "type":"list", + "member":{"shape":"NotificationARN"}, + "max":5 + }, + "OnFailure":{ + "type":"string", + "enum":[ + "DO_NOTHING", + "ROLLBACK", + "DELETE" + ] + }, + "Output":{ + "type":"structure", + "members":{ + "OutputKey":{ + "shape":"OutputKey", + "documentation":"

The key associated with the output.

" + }, + "OutputValue":{ + "shape":"OutputValue", + "documentation":"

The value associated with the output.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the output.

" + } + }, + "documentation":"

The Output data type.

" + }, + "OutputKey":{"type":"string"}, + "OutputValue":{"type":"string"}, + "Outputs":{ + "type":"list", + "member":{"shape":"Output"} + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterKey":{ + "shape":"ParameterKey", + "documentation":"

The key associated with the parameter.

" + }, + "ParameterValue":{ + "shape":"ParameterValue", + "documentation":"

The value associated with the parameter.

" + }, + "UsePreviousValue":{ + "shape":"UsePreviousValue", + "documentation":"

During a stack update, use the existing parameter value that is being used for the stack.

" + } + }, + "documentation":"

The Parameter data type.

" + }, + "ParameterKey":{"type":"string"}, + "ParameterValue":{"type":"string"}, + "Parameters":{ + "type":"list", + "member":{"shape":"Parameter"} + }, + "PhysicalResourceId":{"type":"string"}, + "ResourceProperties":{"type":"string"}, + "ResourceStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "CREATE_COMPLETE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETE_COMPLETE", + "UPDATE_IN_PROGRESS", + "UPDATE_FAILED", + "UPDATE_COMPLETE" + ] + }, + "ResourceStatusReason":{"type":"string"}, + "ResourceType":{"type":"string"}, + "SetStackPolicyInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or stack ID that you want to associate a policy with.

" + }, + "StackPolicyBody":{ + "shape":"StackPolicyBody", + "documentation":"

Structure containing the stack policy body. For more information, go to \n Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" + }, + "StackPolicyURL":{ + "shape":"StackPolicyURL", + "documentation":"

Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" + } + }, + "documentation":"

The input for the SetStackPolicy action.

" + }, + "Stack":{ + "type":"structure", + "required":[ + "StackName", + "CreationTime", + "StackStatus" + ], + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + }, + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the stack.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures.

" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

Time at which the stack was created.

" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"

The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.

" + }, + "StackStatus":{ + "shape":"StackStatus", + "documentation":"

Current status of the stack.

" + }, + "StackStatusReason":{ + "shape":"StackStatusReason", + "documentation":"

Success/failure message associated with the stack status.

" + }, + "DisableRollback":{ + "shape":"DisableRollback", + "documentation":"

Boolean to enable or disable rollback on stack creation failures:

\n

\n

\n

" + }, + "NotificationARNs":{ + "shape":"NotificationARNs", + "documentation":"

SNS topic ARNs to which stack related events are published.

" + }, + "TimeoutInMinutes":{ + "shape":"TimeoutMinutes", + "documentation":"

The amount of time within which stack creation should complete.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

The capabilities allowed in the stack.

" + }, + "Outputs":{ + "shape":"Outputs", + "documentation":"

A list of output structures.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of Tags that specify cost allocation information for the stack.

" + } + }, + "documentation":"

The Stack data type.

" + }, + "StackEvent":{ + "type":"structure", + "required":[ + "StackId", + "EventId", + "StackName", + "Timestamp" + ], + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

The unique ID name of the instance of the stack.

" + }, + "EventId":{ + "shape":"EventId", + "documentation":"

The unique ID of this event.

" + }, + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with a stack.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier associated with the physical instance of the resource.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Type of resource. (For more information, go to \n AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Time the status was updated.

" + }, + "ResourceStatus":{ + "shape":"ResourceStatus", + "documentation":"

Current status of the resource.

" + }, + "ResourceStatusReason":{ + "shape":"ResourceStatusReason", + "documentation":"

Success/failure message associated with the resource.

" + }, + "ResourceProperties":{ + "shape":"ResourceProperties", + "documentation":"

BLOB of the properties used to create the resource.

" + } + }, + "documentation":"

The StackEvent data type.

" + }, + "StackEvents":{ + "type":"list", + "member":{"shape":"StackEvent"} + }, + "StackId":{"type":"string"}, + "StackName":{"type":"string"}, + "StackPolicyBody":{ + "type":"string", + "min":1, + "max":16384 + }, + "StackPolicyDuringUpdateBody":{ + "type":"string", + "min":1, + "max":16384 + }, + "StackPolicyDuringUpdateURL":{ + "type":"string", + "min":1, + "max":1350 + }, + "StackPolicyURL":{ + "type":"string", + "min":1, + "max":1350 + }, + "StackResource":{ + "type":"structure", + "required":[ + "LogicalResourceId", + "ResourceType", + "Timestamp", + "ResourceStatus" + ], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack.

" + }, + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Type of resource. (For more information, go to \n AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Time the status was updated.

" + }, + "ResourceStatus":{ + "shape":"ResourceStatus", + "documentation":"

Current status of the resource.

" + }, + "ResourceStatusReason":{ + "shape":"ResourceStatusReason", + "documentation":"

Success/failure message associated with the resource.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the resource.

" + } + }, + "documentation":"

The StackResource data type.

" + }, + "StackResourceDetail":{ + "type":"structure", + "required":[ + "LogicalResourceId", + "ResourceType", + "LastUpdatedTimestamp", + "ResourceStatus" + ], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack.

" + }, + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Type of resource. ((For more information, go to \n AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

Time the status was updated.

" + }, + "ResourceStatus":{ + "shape":"ResourceStatus", + "documentation":"

Current status of the resource.

" + }, + "ResourceStatusReason":{ + "shape":"ResourceStatusReason", + "documentation":"

Success/failure message associated with the resource.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the resource.

" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

The JSON format content of the Metadata attribute declared for the resource. For more\n information, see Metadata Attribute in the AWS CloudFormation User Guide.

" + } + }, + "documentation":"

Contains detailed information about the specified stack resource.

" + }, + "StackResourceSummaries":{ + "type":"list", + "member":{"shape":"StackResourceSummary"} + }, + "StackResourceSummary":{ + "type":"structure", + "required":[ + "LogicalResourceId", + "ResourceType", + "LastUpdatedTimestamp", + "ResourceStatus" + ], + "members":{ + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of the resource.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Type of resource. (For more information, go to \n AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

Time the status was updated.

" + }, + "ResourceStatus":{ + "shape":"ResourceStatus", + "documentation":"

Current status of the resource.

" + }, + "ResourceStatusReason":{ + "shape":"ResourceStatusReason", + "documentation":"

Success/failure message associated with the resource.

" + } + }, + "documentation":"

Contains high-level information about the specified stack resource.

" + }, + "StackResources":{ + "type":"list", + "member":{"shape":"StackResource"} + }, + "StackStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "CREATE_COMPLETE", + "ROLLBACK_IN_PROGRESS", + "ROLLBACK_FAILED", + "ROLLBACK_COMPLETE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETE_COMPLETE", + "UPDATE_IN_PROGRESS", + "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", + "UPDATE_COMPLETE", + "UPDATE_ROLLBACK_IN_PROGRESS", + "UPDATE_ROLLBACK_FAILED", + "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", + "UPDATE_ROLLBACK_COMPLETE" + ] + }, + "StackStatusFilter":{ + "type":"list", + "member":{"shape":"StackStatus"} + }, + "StackStatusReason":{"type":"string"}, + "StackSummaries":{ + "type":"list", + "member":{"shape":"StackSummary"} + }, + "StackSummary":{ + "type":"structure", + "required":[ + "StackName", + "CreationTime", + "StackStatus" + ], + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

Unique stack identifier.

" + }, + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack.

" + }, + "TemplateDescription":{ + "shape":"TemplateDescription", + "documentation":"

The template description of the template used to create the stack.

" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

The time the stack was created.

" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"

The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.

" + }, + "DeletionTime":{ + "shape":"DeletionTime", + "documentation":"

The time the stack was deleted.

" + }, + "StackStatus":{ + "shape":"StackStatus", + "documentation":"

The current status of the stack.

" + }, + "StackStatusReason":{ + "shape":"StackStatusReason", + "documentation":"

Success/Failure message associated with the stack status.

" + } + }, + "documentation":"

The StackSummary Data Type

" + }, + "Stacks":{ + "type":"list", + "member":{"shape":"Stack"} + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key.\n Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a\n tag value.

" + } + }, + "documentation":"

The Tag type is used by CreateStack in the Tags parameter. It allows you to specify a\n key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation\n stack.

" + }, + "TagKey":{"type":"string"}, + "TagValue":{"type":"string"}, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TemplateBody":{ + "type":"string", + "min":1 + }, + "TemplateDescription":{"type":"string"}, + "TemplateParameter":{ + "type":"structure", + "members":{ + "ParameterKey":{ + "shape":"ParameterKey", + "documentation":"

The name associated with the parameter.

" + }, + "DefaultValue":{ + "shape":"ParameterValue", + "documentation":"

The default value associated with the parameter.

" + }, + "NoEcho":{ + "shape":"NoEcho", + "documentation":"

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the parameter.

" + } + }, + "documentation":"

The TemplateParameter data type.

" + }, + "TemplateParameters":{ + "type":"list", + "member":{"shape":"TemplateParameter"} + }, + "TemplateURL":{ + "type":"string", + "min":1, + "max":1024 + }, + "TimeoutMinutes":{ + "type":"integer", + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "UpdateStackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or stack ID of the stack to update.

\n Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum\n length of the name is 255 characters. " + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.)

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the\n same region as the stack. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + }, + "UsePreviousTemplate":{ + "shape":"UsePreviousTemplate", + "documentation":"

Reuse the existing template that is associated with the stack that you are updating.

" + }, + "StackPolicyDuringUpdateBody":{ + "shape":"StackPolicyDuringUpdateBody", + "documentation":"

Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

" + }, + "StackPolicyDuringUpdateURL":{ + "shape":"StackPolicyDuringUpdateURL", + "documentation":"

Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack.\n You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures that specify input parameters for the stack.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

The list of capabilities that you want to allow in the stack. If your stack contains IAM resources, you must\n specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities\n error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

" + }, + "StackPolicyBody":{ + "shape":"StackPolicyBody", + "documentation":"

Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

\n

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

" + }, + "StackPolicyURL":{ + "shape":"StackPolicyURL", + "documentation":"

Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

\n

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

" + }, + "NotificationARNs":{ + "shape":"NotificationARNs", + "documentation":"

Update the ARNs for the Amazon SNS topics that are associated with the stack.

" + } + }, + "documentation":"

The input for UpdateStack action.

" + }, + "UpdateStackOutput":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + } + }, + "documentation":"

The output for a UpdateStack action.

" + }, + "Url":{"type":"string"}, + "UsePreviousTemplate":{"type":"boolean"}, + "UsePreviousValue":{"type":"boolean"}, + "ValidateTemplateInput":{ + "type":"structure", + "members":{ + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes)\n located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + } + }, + "documentation":"

The input for ValidateTemplate action.

" + }, + "ValidateTemplateOutput":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"TemplateParameters", + "documentation":"

A list of TemplateParameter structures.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description found within the template.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

The capabilities found within the template. Currently, CAPABILITY_IAM is the only capability detected. If\n your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template; otherwise, those actions return an\n InsufficientCapabilities error.

" + }, + "CapabilitiesReason":{ + "shape":"CapabilitiesReason", + "documentation":"

The capabilities reason found within the template.

" + } + }, + "documentation":"

The output for ValidateTemplate action.

" + } + } +} diff --git a/apis/cloudformation-2010-05-15.paginators.json b/apis/cloudformation-2010-05-15.paginators.json new file mode 100644 index 0000000000..da6c17d42b --- /dev/null +++ b/apis/cloudformation-2010-05-15.paginators.json @@ -0,0 +1,27 @@ +{ + "pagination": { + "DescribeStackEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackEvents" + }, + "DescribeStackResources": { + "result_key": "StackResources" + }, + "DescribeStacks": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Stacks" + }, + "ListStackResources": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackResourceSummaries" + }, + "ListStacks": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackSummaries" + } + } +} diff --git a/apis/cloudfront-2014-05-31.api.json b/apis/cloudfront-2014-05-31.api.json new file mode 100644 index 0000000000..eb91c2ed59 --- /dev/null +++ b/apis/cloudfront-2014-05-31.api.json @@ -0,0 +1,1497 @@ +{ + "metadata": { + "apiVersion": "2014-05-31", + "endpointPrefix": "cloudfront", + "globalEndpoint": "cloudfront.amazonaws.com", + "serviceAbbreviation": "CloudFront", + "serviceFullName": "Amazon CloudFront", + "signatureVersion": "v4", + "protocol": "rest-xml" + }, + "operations": { + "CreateCloudFrontOriginAccessIdentity": { + "http": { + "requestUri": "/2014-05-31/origin-access-identity/cloudfront", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "xmlNamespace": "http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName": "CloudFrontOriginAccessIdentityConfig" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "CreateDistribution": { + "http": { + "requestUri": "/2014-05-31/distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "xmlNamespace": "http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName": "DistributionConfig" + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1c" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "CreateInvalidation": { + "http": { + "requestUri": "/2014-05-31/distribution/{DistributionId}/invalidation", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "InvalidationBatch" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "InvalidationBatch": { + "shape": "S1k", + "xmlNamespace": "http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName": "InvalidationBatch" + } + }, + "payload": "InvalidationBatch" + }, + "output": { + "type": "structure", + "members": { + "Location": { + "location": "header", + "locationName": "Location" + }, + "Invalidation": { + "shape": "S1o" + } + }, + "payload": "Invalidation" + } + }, + "CreateStreamingDistribution": { + "http": { + "requestUri": "/2014-05-31/streaming-distribution", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S1q", + "xmlNamespace": "http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName": "StreamingDistributionConfig" + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S1u" + }, + "Location": { + "location": "header", + "locationName": "Location" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "DeleteCloudFrontOriginAccessIdentity": { + "http": { + "method": "DELETE", + "requestUri": "/2014-05-31/origin-access-identity/cloudfront/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "required": [ + "Id" + ] + } + }, + "DeleteDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2014-05-31/distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "required": [ + "Id" + ] + } + }, + "DeleteStreamingDistribution": { + "http": { + "method": "DELETE", + "requestUri": "/2014-05-31/streaming-distribution/{Id}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "required": [ + "Id" + ] + } + }, + "GetCloudFrontOriginAccessIdentity": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/origin-access-identity/cloudfront/{Id}" + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + }, + "required": [ + "Id" + ] + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "GetCloudFrontOriginAccessIdentityConfig": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + }, + "required": [ + "Id" + ] + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + } + }, + "GetDistribution": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/distribution/{Id}" + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + }, + "required": [ + "Id" + ] + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1c" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "GetDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + }, + "required": [ + "Id" + ] + }, + "output": { + "type": "structure", + "members": { + "DistributionConfig": { + "shape": "S7" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "DistributionConfig" + } + }, + "GetInvalidation": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/distribution/{DistributionId}/invalidation/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId", + "Id" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Invalidation": { + "shape": "S1o" + } + }, + "payload": "Invalidation" + } + }, + "GetStreamingDistribution": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/streaming-distribution/{Id}" + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + }, + "required": [ + "Id" + ] + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S1u" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + }, + "GetStreamingDistributionConfig": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + }, + "required": [ + "Id" + ] + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionConfig": { + "shape": "S1q" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistributionConfig" + } + }, + "ListCloudFrontOriginAccessIdentities": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/origin-access-identity/cloudfront" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CloudFrontOriginAccessIdentitySummary", + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "Comment": {} + } + } + } + } + } + }, + "payload": "CloudFrontOriginAccessIdentityList" + } + }, + "ListDistributions": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "DistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "DistributionSummary", + "type": "structure", + "required": [ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions" + ], + "members": { + "Id": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "Aliases": { + "shape": "S8" + }, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sh" + }, + "CacheBehaviors": { + "shape": "Sx" + }, + "CustomErrorResponses": { + "shape": "S10" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S15" + }, + "Restrictions": { + "shape": "S17" + } + } + } + } + } + } + }, + "payload": "DistributionList" + } + }, + "ListInvalidations": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/distribution/{DistributionId}/invalidation" + }, + "input": { + "type": "structure", + "required": [ + "DistributionId" + ], + "members": { + "DistributionId": { + "location": "uri", + "locationName": "DistributionId" + }, + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "InvalidationList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "InvalidationSummary", + "type": "structure", + "required": [ + "Id", + "CreateTime", + "Status" + ], + "members": { + "Id": {}, + "CreateTime": { + "type": "timestamp" + }, + "Status": {} + } + } + } + } + } + }, + "payload": "InvalidationList" + } + }, + "ListStreamingDistributions": { + "http": { + "method": "GET", + "requestUri": "/2014-05-31/streaming-distribution" + }, + "input": { + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "Marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "MaxItems" + } + } + }, + "output": { + "type": "structure", + "members": { + "StreamingDistributionList": { + "type": "structure", + "required": [ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members": { + "Marker": {}, + "NextMarker": {}, + "MaxItems": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "StreamingDistributionSummary", + "type": "structure", + "required": [ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members": { + "Id": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "S3Origin": { + "shape": "S1r" + }, + "Aliases": { + "shape": "S8" + }, + "TrustedSigners": { + "shape": "Sq" + }, + "Comment": {}, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "payload": "StreamingDistributionList" + } + }, + "UpdateCloudFrontOriginAccessIdentity": { + "http": { + "method": "PUT", + "requestUri": "/2014-05-31/origin-access-identity/cloudfront/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2", + "xmlNamespace": "http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName": "CloudFrontOriginAccessIdentityConfig" + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "CloudFrontOriginAccessIdentityConfig" + }, + "output": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentity": { + "shape": "S5" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "CloudFrontOriginAccessIdentity" + } + }, + "UpdateDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2014-05-31/distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "DistributionConfig", + "Id" + ], + "members": { + "DistributionConfig": { + "shape": "S7", + "xmlNamespace": "http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName": "DistributionConfig" + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "DistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "Distribution": { + "shape": "S1c" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "Distribution" + } + }, + "UpdateStreamingDistribution": { + "http": { + "method": "PUT", + "requestUri": "/2014-05-31/streaming-distribution/{Id}/config" + }, + "input": { + "type": "structure", + "required": [ + "StreamingDistributionConfig", + "Id" + ], + "members": { + "StreamingDistributionConfig": { + "shape": "S1q", + "xmlNamespace": "http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName": "StreamingDistributionConfig" + }, + "Id": { + "location": "uri", + "locationName": "Id" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + } + }, + "payload": "StreamingDistributionConfig" + }, + "output": { + "type": "structure", + "members": { + "StreamingDistribution": { + "shape": "S1u" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + } + }, + "payload": "StreamingDistribution" + } + } + }, + "shapes": { + "S2": { + "type": "structure", + "required": [ + "CallerReference", + "Comment" + ], + "members": { + "CallerReference": {}, + "Comment": {} + } + }, + "S5": { + "type": "structure", + "required": [ + "Id", + "S3CanonicalUserId" + ], + "members": { + "Id": {}, + "S3CanonicalUserId": {}, + "CloudFrontOriginAccessIdentityConfig": { + "shape": "S2" + } + } + }, + "S7": { + "type": "structure", + "required": [ + "CallerReference", + "Aliases", + "DefaultRootObject", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "Comment", + "Logging", + "PriceClass", + "Enabled" + ], + "members": { + "CallerReference": {}, + "Aliases": { + "shape": "S8" + }, + "DefaultRootObject": {}, + "Origins": { + "shape": "Sb" + }, + "DefaultCacheBehavior": { + "shape": "Sh" + }, + "CacheBehaviors": { + "shape": "Sx" + }, + "CustomErrorResponses": { + "shape": "S10" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "IncludeCookies": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + }, + "ViewerCertificate": { + "shape": "S15" + }, + "Restrictions": { + "shape": "S17" + } + } + }, + "S8": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CNAME" + } + } + } + }, + "Sb": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Origin", + "type": "structure", + "required": [ + "Id", + "DomainName" + ], + "members": { + "Id": {}, + "DomainName": {}, + "S3OriginConfig": { + "type": "structure", + "required": [ + "OriginAccessIdentity" + ], + "members": { + "OriginAccessIdentity": {} + } + }, + "CustomOriginConfig": { + "type": "structure", + "required": [ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members": { + "HTTPPort": { + "type": "integer" + }, + "HTTPSPort": { + "type": "integer" + }, + "OriginProtocolPolicy": {} + } + } + } + } + } + } + }, + "Sh": { + "type": "structure", + "required": [ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "Si" + }, + "TrustedSigners": { + "shape": "Sq" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "Su" + }, + "SmoothStreaming": { + "type": "boolean" + } + } + }, + "Si": { + "type": "structure", + "required": [ + "QueryString", + "Cookies" + ], + "members": { + "QueryString": { + "type": "boolean" + }, + "Cookies": { + "type": "structure", + "required": [ + "Forward" + ], + "members": { + "Forward": {}, + "WhitelistedNames": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Headers": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Name" + } + } + } + } + } + }, + "Sq": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "AwsAccountNumber" + } + } + } + }, + "Su": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Method" + } + } + } + }, + "Sx": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CacheBehavior", + "type": "structure", + "required": [ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members": { + "PathPattern": {}, + "TargetOriginId": {}, + "ForwardedValues": { + "shape": "Si" + }, + "TrustedSigners": { + "shape": "Sq" + }, + "ViewerProtocolPolicy": {}, + "MinTTL": { + "type": "long" + }, + "AllowedMethods": { + "shape": "Su" + }, + "SmoothStreaming": { + "type": "boolean" + } + } + } + } + } + }, + "S10": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "CustomErrorResponse", + "type": "structure", + "required": [ + "ErrorCode" + ], + "members": { + "ErrorCode": { + "type": "integer" + }, + "ResponsePagePath": {}, + "ResponseCode": {}, + "ErrorCachingMinTTL": { + "type": "long" + } + } + } + } + } + }, + "S15": { + "type": "structure", + "members": { + "IAMCertificateId": {}, + "CloudFrontDefaultCertificate": { + "type": "boolean" + }, + "SSLSupportMethod": {} + } + }, + "S17": { + "type": "structure", + "required": [ + "GeoRestriction" + ], + "members": { + "GeoRestriction": { + "type": "structure", + "required": [ + "RestrictionType", + "Quantity" + ], + "members": { + "RestrictionType": {}, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Location" + } + } + } + } + } + }, + "S1c": { + "type": "structure", + "required": [ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members": { + "Id": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "InProgressInvalidationBatches": { + "type": "integer" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1e" + }, + "DistributionConfig": { + "shape": "S7" + } + } + }, + "S1e": { + "type": "structure", + "required": [ + "Enabled", + "Quantity" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Signer", + "type": "structure", + "members": { + "AwsAccountNumber": {}, + "KeyPairIds": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "KeyPairId" + } + } + } + } + } + } + } + } + }, + "S1k": { + "type": "structure", + "required": [ + "Paths", + "CallerReference" + ], + "members": { + "Paths": { + "type": "structure", + "required": [ + "Quantity" + ], + "members": { + "Quantity": { + "type": "integer" + }, + "Items": { + "type": "list", + "member": { + "locationName": "Path" + } + } + } + }, + "CallerReference": {} + } + }, + "S1o": { + "type": "structure", + "required": [ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members": { + "Id": {}, + "Status": {}, + "CreateTime": { + "type": "timestamp" + }, + "InvalidationBatch": { + "shape": "S1k" + } + } + }, + "S1q": { + "type": "structure", + "required": [ + "CallerReference", + "S3Origin", + "Aliases", + "Comment", + "Logging", + "TrustedSigners", + "PriceClass", + "Enabled" + ], + "members": { + "CallerReference": {}, + "S3Origin": { + "shape": "S1r" + }, + "Aliases": { + "shape": "S8" + }, + "Comment": {}, + "Logging": { + "type": "structure", + "required": [ + "Enabled", + "Bucket", + "Prefix" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Bucket": {}, + "Prefix": {} + } + }, + "TrustedSigners": { + "shape": "Sq" + }, + "PriceClass": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "S1r": { + "type": "structure", + "required": [ + "DomainName", + "OriginAccessIdentity" + ], + "members": { + "DomainName": {}, + "OriginAccessIdentity": {} + } + }, + "S1u": { + "type": "structure", + "required": [ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members": { + "Id": {}, + "Status": {}, + "LastModifiedTime": { + "type": "timestamp" + }, + "DomainName": {}, + "ActiveTrustedSigners": { + "shape": "S1e" + }, + "StreamingDistributionConfig": { + "shape": "S1q" + } + } + } + } +} \ No newline at end of file diff --git a/apis/cloudfront-2014-05-31.full.json b/apis/cloudfront-2014-05-31.full.json new file mode 100644 index 0000000000..6ddf0e45b7 --- /dev/null +++ b/apis/cloudfront-2014-05-31.full.json @@ -0,0 +1,3540 @@ +{ + "metadata":{ + "apiVersion":"2014-05-31", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "signatureVersion":"v4", + "protocol":"rest-xml" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2014_05_31", + "http":{ + "method":"POST", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{ + "shape":"CreateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to create a new origin access identity." + }, + "output":{ + "shape":"CreateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CloudFrontOriginAccessIdentityAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyCloudFrontOriginAccessIdentities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2014_05_31", + "http":{ + "method":"POST", + "requestUri":"/2014-05-31/distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateDistributionRequest", + "documentation":"The request to create a new distribution." + }, + "output":{ + "shape":"CreateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"DistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"TooManyDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2014_05_31", + "http":{ + "method":"POST", + "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{ + "shape":"CreateInvalidationRequest", + "documentation":"The request to create an invalidation." + }, + "output":{ + "shape":"CreateInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"BatchTooLarge", + "error":{"httpStatusCode":413}, + "exception":true + }, + { + "shape":"TooManyInvalidationsInProgress", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2014_05_31", + "http":{ + "method":"POST", + "requestUri":"/2014-05-31/streaming-distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateStreamingDistributionRequest", + "documentation":"The request to create a new streaming distribution." + }, + "output":{ + "shape":"CreateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"StreamingDistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyStreamingDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2014_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to delete a origin access identity." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"CloudFrontOriginAccessIdentityInUse", + "error":{"httpStatusCode":409}, + "exception":true + } + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2014_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2014-05-31/distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteDistributionRequest", + "documentation":"The request to delete a distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"DistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2014_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2014-05-31/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteStreamingDistributionRequest", + "documentation":"The request to delete a streaming distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"StreamingDistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to get an origin access identity's information." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", + "documentation":"The request to get an origin access identity's configuration." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution/{Id}" + }, + "input":{ + "shape":"GetDistributionRequest", + "documentation":"The request to get a distribution's information." + }, + "output":{ + "shape":"GetDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution/{Id}/config" + }, + "input":{ + "shape":"GetDistributionConfigRequest", + "documentation":"The request to get a distribution configuration." + }, + "output":{ + "shape":"GetDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{ + "shape":"GetInvalidationRequest", + "documentation":"The request to get an invalidation's information." + }, + "output":{ + "shape":"GetInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchInvalidation", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/streaming-distribution/{Id}" + }, + "input":{ + "shape":"GetStreamingDistributionRequest", + "documentation":"The request to get a streaming distribution's information." + }, + "output":{ + "shape":"GetStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"GetStreamingDistributionConfigRequest", + "documentation":"To request to get a streaming distribution configuration." + }, + "output":{ + "shape":"GetStreamingDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront" + }, + "input":{ + "shape":"ListCloudFrontOriginAccessIdentitiesRequest", + "documentation":"The request to list origin access identities." + }, + "output":{ + "shape":"ListCloudFrontOriginAccessIdentitiesResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution" + }, + "input":{ + "shape":"ListDistributionsRequest", + "documentation":"The request to list your distributions." + }, + "output":{ + "shape":"ListDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List distributions." + }, + "ListInvalidations":{ + "name":"ListInvalidations2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation" + }, + "input":{ + "shape":"ListInvalidationsRequest", + "documentation":"The request to list invalidations." + }, + "output":{ + "shape":"ListInvalidationsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/streaming-distribution" + }, + "input":{ + "shape":"ListStreamingDistributionsRequest", + "documentation":"The request to list your streaming distributions." + }, + "output":{ + "shape":"ListStreamingDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2014_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"UpdateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to update an origin access identity." + }, + "output":{ + "shape":"UpdateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2014_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2014-05-31/distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateDistributionRequest", + "documentation":"The request to update a distribution." + }, + "output":{ + "shape":"UpdateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2014_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2014-05-31/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateStreamingDistributionRequest", + "documentation":"The request to update a streaming distribution." + }, + "output":{ + "shape":"UpdateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests)." + }, + "Items":{ + "shape":"AllowedMethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + } + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are two options: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests. If you choose the second option, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AllowedMethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "xmlNamespace":"http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName":"CloudFrontOriginAccessIdentityConfig" + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":"http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName":"DistributionConfig" + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "xmlNamespace":"http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName":"InvalidationBatch" + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":"http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName":"StreamingDistributionConfig" + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The origin access identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a origin access identity.", + "required":["Id"] + }, + "DeleteDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a distribution.", + "required":["Id"] + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a streaming distribution.", + "required":["Id"] + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Aliases", + "DefaultRootObject", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "Comment", + "Logging", + "PriceClass", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's configuration.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's information.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution configuration.", + "required":["Id"] + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution's information.", + "required":["Id"] + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The invalidation's id." + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"To request to get a streaming distribution configuration.", + "required":["Id"] + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"The request to get a streaming distribution's information.", + "required":["Id"] + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of origin access identities you want in the response body." + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of distributions you want in the response body." + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of invalidation batches you want in the response body." + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of streaming distributions you want in the response body." + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer" + ] + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Aliases", + "Comment", + "Logging", + "TrustedSigners", + "PriceClass", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "xmlNamespace":"http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName":"CloudFrontOriginAccessIdentityConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":"http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName":"DistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":"http://cloudfront.amazonaws.com/doc/2014-05-31/", + "locationName":"StreamingDistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." + }, + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + } +} diff --git a/apis/cloudfront-2014-05-31.paginators.json b/apis/cloudfront-2014-05-31.paginators.json new file mode 100644 index 0000000000..51fbb907fa --- /dev/null +++ b/apis/cloudfront-2014-05-31.paginators.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/apis/cloudfront-2014-05-31.waiters.json b/apis/cloudfront-2014-05-31.waiters.json new file mode 100644 index 0000000000..e4dc1f4b9b --- /dev/null +++ b/apis/cloudfront-2014-05-31.waiters.json @@ -0,0 +1,29 @@ +{ + "waiters": { + "__default__": { + "success_type": "output", + "success_path": "Status" + }, + "StreamingDistributionDeployed": { + "operation": "GetStreamingDistribution", + "description": "Wait until a streaming distribution is deployed.", + "interval": 60, + "max_attempts": 25, + "success_value": "Deployed" + }, + "DistributionDeployed": { + "operation": "GetDistribution", + "description": "Wait until a distribution is deployed.", + "interval": 60, + "max_attempts": 25, + "success_value": "Deployed" + }, + "InvalidationCompleted": { + "operation": "GetInvalidation", + "description": "Wait until an invalidation has completed.", + "interval": 20, + "max_attempts": 30, + "success_value": "Completed" + } + } +} diff --git a/apis/cloudsearch-2011-02-01.api.json b/apis/cloudsearch-2011-02-01.api.json new file mode 100644 index 0000000000..5db90f2333 --- /dev/null +++ b/apis/cloudsearch-2011-02-01.api.json @@ -0,0 +1,837 @@ +{ + "metadata": { + "apiVersion": "2011-02-01", + "endpointPrefix": "cloudsearch", + "serviceFullName": "Amazon CloudSearch", + "signatureVersion": "v4", + "xmlNamespace": "http://cloudsearch.amazonaws.com/doc/2011-02-01/", + "protocol": "query" + }, + "operations": { + "CreateDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "CreateDomainResult", + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S4" + } + } + } + }, + "DefineIndexField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "IndexField" + ], + "members": { + "DomainName": {}, + "IndexField": { + "shape": "Sf" + } + } + }, + "output": { + "resultWrapper": "DefineIndexFieldResult", + "type": "structure", + "required": [ + "IndexField" + ], + "members": { + "IndexField": { + "shape": "Sx" + } + } + } + }, + "DefineRankExpression": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "RankExpression" + ], + "members": { + "DomainName": {}, + "RankExpression": { + "shape": "S12" + } + } + }, + "output": { + "resultWrapper": "DefineRankExpressionResult", + "type": "structure", + "required": [ + "RankExpression" + ], + "members": { + "RankExpression": { + "shape": "S15" + } + } + } + }, + "DeleteDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DeleteDomainResult", + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S4" + } + } + } + }, + "DeleteIndexField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "IndexFieldName" + ], + "members": { + "DomainName": {}, + "IndexFieldName": {} + } + }, + "output": { + "resultWrapper": "DeleteIndexFieldResult", + "type": "structure", + "required": [ + "IndexField" + ], + "members": { + "IndexField": { + "shape": "Sx" + } + } + } + }, + "DeleteRankExpression": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "RankName" + ], + "members": { + "DomainName": {}, + "RankName": {} + } + }, + "output": { + "resultWrapper": "DeleteRankExpressionResult", + "type": "structure", + "required": [ + "RankExpression" + ], + "members": { + "RankExpression": { + "shape": "S15" + } + } + } + }, + "DescribeAvailabilityOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeAvailabilityOptionsResult", + "type": "structure", + "members": { + "AvailabilityOptions": { + "shape": "S1e" + } + } + } + }, + "DescribeDefaultSearchField": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeDefaultSearchFieldResult", + "type": "structure", + "required": [ + "DefaultSearchField" + ], + "members": { + "DefaultSearchField": { + "shape": "S1i" + } + } + } + }, + "DescribeDomains": { + "input": { + "type": "structure", + "members": { + "DomainNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeDomainsResult", + "type": "structure", + "required": [ + "DomainStatusList" + ], + "members": { + "DomainStatusList": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + } + }, + "DescribeIndexFields": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "FieldNames": { + "shape": "S1o" + } + } + }, + "output": { + "resultWrapper": "DescribeIndexFieldsResult", + "type": "structure", + "required": [ + "IndexFields" + ], + "members": { + "IndexFields": { + "type": "list", + "member": { + "shape": "Sx" + } + } + } + } + }, + "DescribeRankExpressions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "RankNames": { + "shape": "S1o" + } + } + }, + "output": { + "resultWrapper": "DescribeRankExpressionsResult", + "type": "structure", + "required": [ + "RankExpressions" + ], + "members": { + "RankExpressions": { + "type": "list", + "member": { + "shape": "S15" + } + } + } + } + }, + "DescribeServiceAccessPolicies": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeServiceAccessPoliciesResult", + "type": "structure", + "required": [ + "AccessPolicies" + ], + "members": { + "AccessPolicies": { + "shape": "S1w" + } + } + } + }, + "DescribeStemmingOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeStemmingOptionsResult", + "type": "structure", + "required": [ + "Stems" + ], + "members": { + "Stems": { + "shape": "S20" + } + } + } + }, + "DescribeStopwordOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeStopwordOptionsResult", + "type": "structure", + "required": [ + "Stopwords" + ], + "members": { + "Stopwords": { + "shape": "S24" + } + } + } + }, + "DescribeSynonymOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeSynonymOptionsResult", + "type": "structure", + "required": [ + "Synonyms" + ], + "members": { + "Synonyms": { + "shape": "S28" + } + } + } + }, + "IndexDocuments": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "IndexDocumentsResult", + "type": "structure", + "members": { + "FieldNames": { + "shape": "S1o" + } + } + } + }, + "UpdateAvailabilityOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "MultiAZ" + ], + "members": { + "DomainName": {}, + "MultiAZ": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "UpdateAvailabilityOptionsResult", + "type": "structure", + "members": { + "AvailabilityOptions": { + "shape": "S1e" + } + } + } + }, + "UpdateDefaultSearchField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "DefaultSearchField" + ], + "members": { + "DomainName": {}, + "DefaultSearchField": {} + } + }, + "output": { + "resultWrapper": "UpdateDefaultSearchFieldResult", + "type": "structure", + "required": [ + "DefaultSearchField" + ], + "members": { + "DefaultSearchField": { + "shape": "S1i" + } + } + } + }, + "UpdateServiceAccessPolicies": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "AccessPolicies" + ], + "members": { + "DomainName": {}, + "AccessPolicies": {} + } + }, + "output": { + "resultWrapper": "UpdateServiceAccessPoliciesResult", + "type": "structure", + "required": [ + "AccessPolicies" + ], + "members": { + "AccessPolicies": { + "shape": "S1w" + } + } + } + }, + "UpdateStemmingOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Stems" + ], + "members": { + "DomainName": {}, + "Stems": {} + } + }, + "output": { + "resultWrapper": "UpdateStemmingOptionsResult", + "type": "structure", + "required": [ + "Stems" + ], + "members": { + "Stems": { + "shape": "S20" + } + } + } + }, + "UpdateStopwordOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Stopwords" + ], + "members": { + "DomainName": {}, + "Stopwords": {} + } + }, + "output": { + "resultWrapper": "UpdateStopwordOptionsResult", + "type": "structure", + "required": [ + "Stopwords" + ], + "members": { + "Stopwords": { + "shape": "S24" + } + } + } + }, + "UpdateSynonymOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Synonyms" + ], + "members": { + "DomainName": {}, + "Synonyms": {} + } + }, + "output": { + "resultWrapper": "UpdateSynonymOptionsResult", + "type": "structure", + "required": [ + "Synonyms" + ], + "members": { + "Synonyms": { + "shape": "S28" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "required": [ + "DomainId", + "DomainName", + "RequiresIndexDocuments" + ], + "members": { + "DomainId": {}, + "DomainName": {}, + "Created": { + "type": "boolean" + }, + "Deleted": { + "type": "boolean" + }, + "NumSearchableDocs": { + "type": "long" + }, + "DocService": { + "shape": "S8" + }, + "SearchService": { + "shape": "S8" + }, + "RequiresIndexDocuments": { + "type": "boolean" + }, + "Processing": { + "type": "boolean" + }, + "SearchInstanceType": {}, + "SearchPartitionCount": { + "type": "integer" + }, + "SearchInstanceCount": { + "type": "integer" + } + } + }, + "S8": { + "type": "structure", + "members": { + "Arn": {}, + "Endpoint": {} + } + }, + "Sf": { + "type": "structure", + "required": [ + "IndexFieldName", + "IndexFieldType" + ], + "members": { + "IndexFieldName": {}, + "IndexFieldType": {}, + "UIntOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "integer" + } + } + }, + "LiteralOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SearchEnabled": { + "type": "boolean" + }, + "FacetEnabled": { + "type": "boolean" + }, + "ResultEnabled": { + "type": "boolean" + } + } + }, + "TextOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "FacetEnabled": { + "type": "boolean" + }, + "ResultEnabled": { + "type": "boolean" + }, + "TextProcessor": {} + } + }, + "SourceAttributes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SourceDataFunction" + ], + "members": { + "SourceDataFunction": {}, + "SourceDataCopy": { + "type": "structure", + "required": [ + "SourceName" + ], + "members": { + "SourceName": {}, + "DefaultValue": {} + } + }, + "SourceDataTrimTitle": { + "type": "structure", + "required": [ + "SourceName" + ], + "members": { + "SourceName": {}, + "DefaultValue": {}, + "Separator": {}, + "Language": {} + } + }, + "SourceDataMap": { + "type": "structure", + "required": [ + "SourceName" + ], + "members": { + "SourceName": {}, + "DefaultValue": {}, + "Cases": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + } + } + }, + "Sx": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sf" + }, + "Status": { + "shape": "Sy" + } + } + }, + "Sy": { + "type": "structure", + "required": [ + "CreationDate", + "UpdateDate", + "State" + ], + "members": { + "CreationDate": { + "type": "timestamp" + }, + "UpdateDate": { + "type": "timestamp" + }, + "UpdateVersion": { + "type": "integer" + }, + "State": {}, + "PendingDeletion": { + "type": "boolean" + } + } + }, + "S12": { + "type": "structure", + "required": [ + "RankName", + "RankExpression" + ], + "members": { + "RankName": {}, + "RankExpression": {} + } + }, + "S15": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "S12" + }, + "Status": { + "shape": "Sy" + } + } + }, + "S1e": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "type": "boolean" + }, + "Status": { + "shape": "Sy" + } + } + }, + "S1i": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + }, + "S1o": { + "type": "list", + "member": {} + }, + "S1w": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + }, + "S20": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + }, + "S24": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + }, + "S28": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sy" + } + } + } + } +} \ No newline at end of file diff --git a/apis/cloudsearch-2011-02-01.full.json b/apis/cloudsearch-2011-02-01.full.json new file mode 100644 index 0000000000..df80f54dec --- /dev/null +++ b/apis/cloudsearch-2011-02-01.full.json @@ -0,0 +1,2093 @@ +{ + "metadata":{ + "apiVersion":"2011-02-01", + "endpointPrefix":"cloudsearch", + "serviceFullName":"Amazon CloudSearch", + "signatureVersion":"v4", + "xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2011-02-01/", + "protocol":"query" + }, + "documentation":"Amazon CloudSearch Configuration Service

You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

", + "operations":{ + "CreateDomain":{ + "name":"CreateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDomainRequest"}, + "output":{ + "shape":"CreateDomainResponse", + "documentation":"

A response message that contains the status of a newly created domain.

", + "resultWrapper":"CreateDomainResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + } + ], + "documentation":"

Creates a new search domain.

" + }, + "DefineIndexField":{ + "name":"DefineIndexField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DefineIndexFieldRequest"}, + "output":{ + "shape":"DefineIndexFieldResponse", + "documentation":"

A response message that contains the status of an updated index field.

", + "resultWrapper":"DefineIndexFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.

" + }, + "DefineRankExpression":{ + "name":"DefineRankExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DefineRankExpressionRequest"}, + "output":{ + "shape":"DefineRankExpressionResponse", + "documentation":"

A response message that contains the status of an updated RankExpression.

", + "resultWrapper":"DefineRankExpressionResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.

" + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDomainRequest"}, + "output":{ + "shape":"DeleteDomainResponse", + "documentation":"

A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

", + "resultWrapper":"DeleteDomainResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + } + ], + "documentation":"

Permanently deletes a search domain and all of its data.

" + }, + "DeleteIndexField":{ + "name":"DeleteIndexField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIndexFieldRequest"}, + "output":{ + "shape":"DeleteIndexFieldResponse", + "documentation":"

A response message that contains the status of a deleted index field.

", + "resultWrapper":"DeleteIndexFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Removes an IndexField from the search domain.

" + }, + "DeleteRankExpression":{ + "name":"DeleteRankExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRankExpressionRequest"}, + "output":{ + "shape":"DeleteRankExpressionResponse", + "documentation":"

A response message that contains the status of a deleted RankExpression.

", + "resultWrapper":"DeleteRankExpressionResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Removes a RankExpression from the search domain.

" + }, + "DescribeAvailabilityOptions":{ + "name":"DescribeAvailabilityOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeAvailabilityOptionsRequest", + "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeAvailabilityOptionsResponse", + "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

", + "resultWrapper":"DescribeAvailabilityOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"DisabledOperationException", + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + } + ], + "documentation":"

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeDefaultSearchField":{ + "name":"DescribeDefaultSearchField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDefaultSearchFieldRequest"}, + "output":{ + "shape":"DescribeDefaultSearchFieldResponse", + "documentation":"

A response message that contains the default search field for a search domain.

", + "resultWrapper":"DescribeDefaultSearchFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the default search field configured for the search domain.

" + }, + "DescribeDomains":{ + "name":"DescribeDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDomainsRequest"}, + "output":{ + "shape":"DescribeDomainsResponse", + "documentation":"

A response message that contains the status of one or more domains.

", + "resultWrapper":"DescribeDomainsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + } + ], + "documentation":"

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.

" + }, + "DescribeIndexFields":{ + "name":"DescribeIndexFields", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIndexFieldsRequest"}, + "output":{ + "shape":"DescribeIndexFieldsResponse", + "documentation":"

A response message that contains the index fields for a search domain.

", + "resultWrapper":"DescribeIndexFieldsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.

" + }, + "DescribeRankExpressions":{ + "name":"DescribeRankExpressions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRankExpressionsRequest"}, + "output":{ + "shape":"DescribeRankExpressionsResponse", + "documentation":"

A response message that contains the rank expressions for a search domain.

", + "resultWrapper":"DescribeRankExpressionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.

" + }, + "DescribeServiceAccessPolicies":{ + "name":"DescribeServiceAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceAccessPoliciesRequest"}, + "output":{ + "shape":"DescribeServiceAccessPoliciesResponse", + "documentation":"

A response message that contains the access policies for a domain.

", + "resultWrapper":"DescribeServiceAccessPoliciesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets information about the resource-based policies that control access to the domain's document and search services.

" + }, + "DescribeStemmingOptions":{ + "name":"DescribeStemmingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStemmingOptionsRequest"}, + "output":{ + "shape":"DescribeStemmingOptionsResponse", + "documentation":"

A response message that contains the stemming options for a search domain.

", + "resultWrapper":"DescribeStemmingOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the stemming dictionary configured for the search domain.

" + }, + "DescribeStopwordOptions":{ + "name":"DescribeStopwordOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStopwordOptionsRequest"}, + "output":{ + "shape":"DescribeStopwordOptionsResponse", + "documentation":"

A response message that contains the stopword options for a search domain.

", + "resultWrapper":"DescribeStopwordOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the stopwords configured for the search domain.

" + }, + "DescribeSynonymOptions":{ + "name":"DescribeSynonymOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSynonymOptionsRequest"}, + "output":{ + "shape":"DescribeSynonymOptionsResponse", + "documentation":"

A response message that contains the synonym options for a search domain.

", + "resultWrapper":"DescribeSynonymOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the synonym dictionary configured for the search domain.

" + }, + "IndexDocuments":{ + "name":"IndexDocuments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"IndexDocumentsRequest"}, + "output":{ + "shape":"IndexDocumentsResponse", + "documentation":"

The result of an IndexDocuments action.

", + "resultWrapper":"IndexDocumentsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.

" + }, + "UpdateAvailabilityOptions":{ + "name":"UpdateAvailabilityOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateAvailabilityOptionsRequest", + "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" + }, + "output":{ + "shape":"UpdateAvailabilityOptionsResponse", + "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

", + "resultWrapper":"UpdateAvailabilityOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"DisabledOperationException", + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + } + ], + "documentation":"

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" + }, + "UpdateDefaultSearchField":{ + "name":"UpdateDefaultSearchField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDefaultSearchFieldRequest"}, + "output":{ + "shape":"UpdateDefaultSearchFieldResponse", + "documentation":"

A response message that contains the status of an updated default search field.

", + "resultWrapper":"UpdateDefaultSearchFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.

" + }, + "UpdateServiceAccessPolicies":{ + "name":"UpdateServiceAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServiceAccessPoliciesRequest"}, + "output":{ + "shape":"UpdateServiceAccessPoliciesResponse", + "documentation":"

A response message that contains the status of updated access policies.

", + "resultWrapper":"UpdateServiceAccessPoliciesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + } + ], + "documentation":"

Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.

" + }, + "UpdateStemmingOptions":{ + "name":"UpdateStemmingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStemmingOptionsRequest"}, + "output":{ + "shape":"UpdateStemmingOptionsResponse", + "documentation":"

A response message that contains the status of updated stemming options.

", + "resultWrapper":"UpdateStemmingOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.

" + }, + "UpdateStopwordOptions":{ + "name":"UpdateStopwordOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStopwordOptionsRequest"}, + "output":{ + "shape":"UpdateStopwordOptionsResponse", + "documentation":"

A response message that contains the status of updated stopword options.

", + "resultWrapper":"UpdateStopwordOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.

" + }, + "UpdateSynonymOptions":{ + "name":"UpdateSynonymOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSynonymOptionsRequest"}, + "output":{ + "shape":"UpdateSynonymOptionsResponse", + "documentation":"

A response message that contains the status of updated synonym options.

", + "resultWrapper":"UpdateSynonymOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.

" + } + }, + "shapes":{ + "AccessPoliciesStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"PolicyDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

" + }, + "Arn":{ + "type":"string", + "documentation":"

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" + }, + "AvailabilityOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"MultiAZ", + "documentation":"

The availability options configured for the domain.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The status and configuration of the domain's availability options.

" + }, + "BaseException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + "Boolean":{"type":"boolean"}, + "CreateDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "CreateDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{"shape":"DomainStatus"} + }, + "documentation":"

A response message that contains the status of a newly created domain.

" + }, + "DefaultSearchFieldStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"FieldName", + "documentation":"

The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of the DefaultSearchField configured for this search domain and its current status.

" + }, + "DefineIndexFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "IndexField" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IndexField":{"shape":"IndexField"} + } + }, + "DefineIndexFieldResponse":{ + "type":"structure", + "required":["IndexField"], + "members":{ + "IndexField":{"shape":"IndexFieldStatus"} + }, + "documentation":"

A response message that contains the status of an updated index field.

" + }, + "DefineRankExpressionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "RankExpression" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "RankExpression":{"shape":"NamedRankExpression"} + } + }, + "DefineRankExpressionResponse":{ + "type":"structure", + "required":["RankExpression"], + "members":{ + "RankExpression":{"shape":"RankExpressionStatus"} + }, + "documentation":"

A response message that contains the status of an updated RankExpression.

" + }, + "DeleteDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DeleteDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{"shape":"DomainStatus"} + }, + "documentation":"

A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

" + }, + "DeleteIndexFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "IndexFieldName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IndexFieldName":{"shape":"FieldName"} + } + }, + "DeleteIndexFieldResponse":{ + "type":"structure", + "required":["IndexField"], + "members":{ + "IndexField":{"shape":"IndexFieldStatus"} + }, + "documentation":"

A response message that contains the status of a deleted index field.

" + }, + "DeleteRankExpressionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "RankName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "RankName":{ + "shape":"FieldName", + "documentation":"

The name of the RankExpression to delete.

" + } + } + }, + "DeleteRankExpressionResponse":{ + "type":"structure", + "required":["RankExpression"], + "members":{ + "RankExpression":{"shape":"RankExpressionStatus"} + }, + "documentation":"

A response message that contains the status of a deleted RankExpression.

" + }, + "DescribeAvailabilityOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + } + }, + "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeAvailabilityOptionsResponse":{ + "type":"structure", + "members":{ + "AvailabilityOptions":{ + "shape":"AvailabilityOptionsStatus", + "documentation":"

The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

" + } + }, + "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

" + }, + "DescribeDefaultSearchFieldRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeDefaultSearchFieldResponse":{ + "type":"structure", + "required":["DefaultSearchField"], + "members":{ + "DefaultSearchField":{ + "shape":"DefaultSearchFieldStatus", + "documentation":"

The name of the IndexField to use for search requests issued with the q parameter. The default is the empty string, which automatically searches all text fields.

" + } + }, + "documentation":"

A response message that contains the default search field for a search domain.

" + }, + "DescribeDomainsRequest":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainNameList", + "documentation":"

Limits the DescribeDomains response to the specified search domains.

" + } + } + }, + "DescribeDomainsResponse":{ + "type":"structure", + "required":["DomainStatusList"], + "members":{ + "DomainStatusList":{"shape":"DomainStatusList"} + }, + "documentation":"

A response message that contains the status of one or more domains.

" + }, + "DescribeIndexFieldsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "FieldNames":{ + "shape":"FieldNameList", + "documentation":"

Limits the DescribeIndexFields response to the specified fields.

" + } + } + }, + "DescribeIndexFieldsResponse":{ + "type":"structure", + "required":["IndexFields"], + "members":{ + "IndexFields":{ + "shape":"IndexFieldStatusList", + "documentation":"

The index fields configured for the domain.

" + } + }, + "documentation":"

A response message that contains the index fields for a search domain.

" + }, + "DescribeRankExpressionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "RankNames":{ + "shape":"FieldNameList", + "documentation":"

Limits the DescribeRankExpressions response to the specified fields.

" + } + } + }, + "DescribeRankExpressionsResponse":{ + "type":"structure", + "required":["RankExpressions"], + "members":{ + "RankExpressions":{ + "shape":"RankExpressionStatusList", + "documentation":"

The rank expressions configured for the domain.

" + } + }, + "documentation":"

A response message that contains the rank expressions for a search domain.

" + }, + "DescribeServiceAccessPoliciesRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeServiceAccessPoliciesResponse":{ + "type":"structure", + "required":["AccessPolicies"], + "members":{ + "AccessPolicies":{"shape":"AccessPoliciesStatus"} + }, + "documentation":"

A response message that contains the access policies for a domain.

" + }, + "DescribeStemmingOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeStemmingOptionsResponse":{ + "type":"structure", + "required":["Stems"], + "members":{ + "Stems":{"shape":"StemmingOptionsStatus"} + }, + "documentation":"

A response message that contains the stemming options for a search domain.

" + }, + "DescribeStopwordOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeStopwordOptionsResponse":{ + "type":"structure", + "required":["Stopwords"], + "members":{ + "Stopwords":{"shape":"StopwordOptionsStatus"} + }, + "documentation":"

A response message that contains the stopword options for a search domain.

" + }, + "DescribeSynonymOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeSynonymOptionsResponse":{ + "type":"structure", + "required":["Synonyms"], + "members":{ + "Synonyms":{"shape":"SynonymOptionsStatus"} + }, + "documentation":"

A response message that contains the synonym options for a search domain.

" + }, + "DisabledOperationException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + }, + "DocumentCount":{ + "type":"long", + "min":0 + }, + "DomainId":{ + "type":"string", + "min":1, + "max":64, + "documentation":"

An internally generated unique identifier for a domain.

" + }, + "DomainName":{ + "type":"string", + "min":3, + "max":28, + "pattern":"[a-z][a-z0-9\\-]+", + "documentation":"

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

" + }, + "DomainNameList":{ + "type":"list", + "member":{"shape":"DomainName"}, + "documentation":"

A list of domain names.

" + }, + "DomainStatus":{ + "type":"structure", + "required":[ + "DomainId", + "DomainName", + "RequiresIndexDocuments" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "DomainName":{"shape":"DomainName"}, + "Created":{ + "shape":"Boolean", + "documentation":"

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

" + }, + "Deleted":{ + "shape":"Boolean", + "documentation":"

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

" + }, + "NumSearchableDocs":{ + "shape":"DocumentCount", + "documentation":"

The number of documents that have been submitted to the domain and indexed.

" + }, + "DocService":{ + "shape":"ServiceEndpoint", + "documentation":"

The service endpoint for updating documents in a search domain.

" + }, + "SearchService":{ + "shape":"ServiceEndpoint", + "documentation":"

The service endpoint for requesting search results from a search domain.

" + }, + "RequiresIndexDocuments":{ + "shape":"Boolean", + "documentation":"

True if IndexDocuments needs to be called to activate the current domain configuration.

" + }, + "Processing":{ + "shape":"Boolean", + "documentation":"

True if processing is being done to activate the current domain configuration.

" + }, + "SearchInstanceType":{ + "shape":"SearchInstanceType", + "documentation":"

The instance type (such as search.m1.small) that is being used to process search requests.

" + }, + "SearchPartitionCount":{ + "shape":"PartitionCount", + "documentation":"

The number of partitions across which the search index is spread.

" + }, + "SearchInstanceCount":{ + "shape":"InstanceCount", + "documentation":"

The number of search instances that are available to process search requests.

" + } + }, + "documentation":"

The current status of the search domain.

" + }, + "DomainStatusList":{ + "type":"list", + "member":{"shape":"DomainStatus"}, + "documentation":"

The current status of all of your search domains.

" + }, + "ErrorCode":{ + "type":"string", + "documentation":"

A machine-parsable string error or warning code.

" + }, + "ErrorMessage":{ + "type":"string", + "documentation":"

A human-readable string error or warning message.

" + }, + "FieldName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-z][a-z0-9_]*", + "documentation":"

A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

" + }, + "FieldNameList":{ + "type":"list", + "member":{"shape":"FieldName"} + }, + "FieldValue":{ + "type":"string", + "min":0, + "max":1024, + "documentation":"

The value of a field or source document attribute.

" + }, + "IndexDocumentsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "IndexDocumentsResponse":{ + "type":"structure", + "members":{ + "FieldNames":{ + "shape":"FieldNameList", + "documentation":"

The names of the fields that are currently being processed due to an IndexDocuments action.

" + } + }, + "documentation":"

The result of an IndexDocuments action.

" + }, + "IndexField":{ + "type":"structure", + "required":[ + "IndexFieldName", + "IndexFieldType" + ], + "members":{ + "IndexFieldName":{ + "shape":"FieldName", + "documentation":"

The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

" + }, + "IndexFieldType":{ + "shape":"IndexFieldType", + "documentation":"

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

" + }, + "UIntOptions":{ + "shape":"UIntOptions", + "documentation":"

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

" + }, + "LiteralOptions":{ + "shape":"LiteralOptions", + "documentation":"

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

" + }, + "TextOptions":{ + "shape":"TextOptions", + "documentation":"

Options for text field. Present if IndexFieldType specifies the field is of type text.

" + }, + "SourceAttributes":{ + "shape":"SourceAttributeList", + "documentation":"

An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

" + } + }, + "documentation":"

Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

" + }, + "IndexFieldStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"IndexField"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of an IndexField and its current status.

" + }, + "IndexFieldStatusList":{ + "type":"list", + "member":{"shape":"IndexFieldStatus"} + }, + "IndexFieldType":{ + "type":"string", + "enum":[ + "uint", + "literal", + "text" + ], + "documentation":"

The type of IndexField.

" + }, + "InstanceCount":{ + "type":"integer", + "min":1 + }, + "InternalException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + "InvalidTypeException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + "Language":{ + "type":"string", + "pattern":"[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", + "documentation":"

An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + "LiteralOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value for a literal field. Optional.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether search is enabled for this field. Default: False.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether facets are enabled for this field. Default: False.

" + }, + "ResultEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

" + } + }, + "documentation":"

Options that define a literal field in the search index.

" + }, + "MultiAZ":{"type":"boolean"}, + "NamedRankExpression":{ + "type":"structure", + "required":[ + "RankName", + "RankExpression" + ], + "members":{ + "RankName":{ + "shape":"FieldName", + "documentation":"

The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

" + }, + "RankExpression":{ + "shape":"RankExpression", + "documentation":"

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

" + } + }, + "documentation":"

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

" + }, + "OptionState":{ + "type":"string", + "enum":[ + "RequiresIndexDocuments", + "Processing", + "Active" + ], + "documentation":"

The state of processing a change to an option.

" + }, + "OptionStatus":{ + "type":"structure", + "required":[ + "CreationDate", + "UpdateDate", + "State" + ], + "members":{ + "CreationDate":{ + "shape":"UpdateTimestamp", + "documentation":"

A timestamp for when this option was created.

" + }, + "UpdateDate":{ + "shape":"UpdateTimestamp", + "documentation":"

A timestamp for when this option was last updated.

" + }, + "UpdateVersion":{ + "shape":"UIntValue", + "documentation":"

A unique integer that indicates when this option was last updated.

" + }, + "State":{ + "shape":"OptionState", + "documentation":"

The state of processing a change to an option. Possible values:

" + }, + "PendingDeletion":{ + "shape":"Boolean", + "documentation":"

Indicates that the option will be deleted once processing is complete.

" + } + }, + "documentation":"

The status of an option, including when it was last updated and whether it is actively in use for searches.

" + }, + "PartitionCount":{ + "type":"integer", + "min":1 + }, + "PolicyDocument":{ + "type":"string", + "documentation":"

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

Example: {\"Statement\": [{\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:search/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }}, {\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:documents/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }} ] }

" + }, + "RankExpression":{ + "type":"string", + "min":1, + "max":10240, + "documentation":"

The current status of the rank expression.

" + }, + "RankExpressionStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"NamedRankExpression", + "documentation":"

The expression that is evaluated for ranking or thresholding while processing a search request.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of a RankExpression and its current status.

" + }, + "RankExpressionStatusList":{ + "type":"list", + "member":{"shape":"RankExpressionStatus"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + "SearchInstanceType":{"type":"string"}, + "ServiceEndpoint":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "Endpoint":{"shape":"ServiceUrl"} + }, + "documentation":"

The endpoint to which service requests can be submitted, including the actual URL prefix for sending requests and the Amazon Resource Name (ARN) so the endpoint can be referenced in other API calls such as UpdateServiceAccessPolicies.

" + }, + "ServiceUrl":{ + "type":"string", + "documentation":"

The URL (including /version/pathPrefix) to which service requests can be submitted.

" + }, + "SourceAttribute":{ + "type":"structure", + "required":["SourceDataFunction"], + "members":{ + "SourceDataFunction":{ + "shape":"SourceDataFunction", + "documentation":"

Identifies the transformation to apply when copying data from a source attribute.

" + }, + "SourceDataCopy":{ + "shape":"SourceData", + "documentation":"

Copies data from a source document attribute to an IndexField.

" + }, + "SourceDataTrimTitle":{ + "shape":"SourceDataTrimTitle", + "documentation":"

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

" + }, + "SourceDataMap":{ + "shape":"SourceDataMap", + "documentation":"

Maps source document attribute values to new values when populating the IndexField.

" + } + }, + "documentation":"

Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.

" + }, + "SourceAttributeList":{ + "type":"list", + "member":{"shape":"SourceAttribute"} + }, + "SourceData":{ + "type":"structure", + "required":["SourceName"], + "members":{ + "SourceName":{ + "shape":"FieldName", + "documentation":"

The name of the document source field to add to this IndexField.

" + }, + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" + } + }, + "documentation":"

The source attribute name and an optional default value to use if a document doesn't have an attribute of that name.

" + }, + "SourceDataFunction":{ + "type":"string", + "enum":[ + "Copy", + "TrimTitle", + "Map" + ] + }, + "SourceDataMap":{ + "type":"structure", + "required":["SourceName"], + "members":{ + "SourceName":{ + "shape":"FieldName", + "documentation":"

The name of the document source field to add to this IndexField.

" + }, + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" + }, + "Cases":{ + "shape":"StringCaseMap", + "documentation":"

A map that translates source field values to custom values.

" + } + }, + "documentation":"

Specifies how to map source attribute values to custom values when populating an IndexField.

" + }, + "SourceDataTrimTitle":{ + "type":"structure", + "required":["SourceName"], + "members":{ + "SourceName":{ + "shape":"FieldName", + "documentation":"

The name of the document source field to add to this IndexField.

" + }, + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" + }, + "Separator":{ + "shape":"String", + "documentation":"

The separator that follows the text to trim.

" + }, + "Language":{"shape":"Language"} + }, + "documentation":"

Specifies how to trim common words from the beginning of a field to enable title sorting by that field.

" + }, + "StemmingOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"StemsDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The stemming options configured for this search domain and the current status of those options.

" + }, + "StemsDocument":{ + "type":"string", + "documentation":"

Maps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }

" + }, + "StopwordOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"StopwordsDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The stopword options configured for this search domain and the current status of those options.

" + }, + "StopwordsDocument":{ + "type":"string", + "documentation":"

Lists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }

" + }, + "String":{"type":"string"}, + "StringCaseMap":{ + "type":"map", + "key":{"shape":"FieldValue"}, + "value":{"shape":"FieldValue"} + }, + "SynonymOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"SynonymsDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The synonym options configured for this search domain and the current status of those options.

" + }, + "SynonymsDocument":{ + "type":"string", + "documentation":"

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }

" + }, + "TextOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value for a text field. Optional.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether facets are enabled for this field. Default: False.

" + }, + "ResultEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

" + }, + "TextProcessor":{ + "shape":"FieldName", + "documentation":"

The text processor to apply to this field. Optional. Possible values:

Default: none

" + } + }, + "documentation":"

Options that define a text field in the search index.

" + }, + "UIntOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"UIntValue", + "documentation":"

The default value for an unsigned integer field. Optional.

" + } + }, + "documentation":"

Options that define a uint field in the search index.

" + }, + "UIntValue":{ + "type":"integer", + "min":0 + }, + "UpdateAvailabilityOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "MultiAZ" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

" + } + }, + "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" + }, + "UpdateAvailabilityOptionsResponse":{ + "type":"structure", + "members":{ + "AvailabilityOptions":{ + "shape":"AvailabilityOptionsStatus", + "documentation":"

The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

" + } + }, + "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

" + }, + "UpdateDefaultSearchFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "DefaultSearchField" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "DefaultSearchField":{ + "shape":"String", + "documentation":"

The text field to search if the search request does not specify which field to search. The default search field is used when search terms are specified with the q parameter, or if a match expression specified with the bq parameter does not constrain the search to a particular field. The default is an empty string, which automatically searches all text fields.

" + } + } + }, + "UpdateDefaultSearchFieldResponse":{ + "type":"structure", + "required":["DefaultSearchField"], + "members":{ + "DefaultSearchField":{"shape":"DefaultSearchFieldStatus"} + }, + "documentation":"

A response message that contains the status of an updated default search field.

" + }, + "UpdateServiceAccessPoliciesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AccessPolicies" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AccessPolicies":{"shape":"PolicyDocument"} + } + }, + "UpdateServiceAccessPoliciesResponse":{ + "type":"structure", + "required":["AccessPolicies"], + "members":{ + "AccessPolicies":{"shape":"AccessPoliciesStatus"} + }, + "documentation":"

A response message that contains the status of updated access policies.

" + }, + "UpdateStemmingOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Stems" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Stems":{"shape":"StemsDocument"} + } + }, + "UpdateStemmingOptionsResponse":{ + "type":"structure", + "required":["Stems"], + "members":{ + "Stems":{"shape":"StemmingOptionsStatus"} + }, + "documentation":"

A response message that contains the status of updated stemming options.

" + }, + "UpdateStopwordOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Stopwords" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Stopwords":{"shape":"StopwordsDocument"} + } + }, + "UpdateStopwordOptionsResponse":{ + "type":"structure", + "required":["Stopwords"], + "members":{ + "Stopwords":{"shape":"StopwordOptionsStatus"} + }, + "documentation":"

A response message that contains the status of updated stopword options.

" + }, + "UpdateSynonymOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Synonyms" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Synonyms":{"shape":"SynonymsDocument"} + } + }, + "UpdateSynonymOptionsResponse":{ + "type":"structure", + "required":["Synonyms"], + "members":{ + "Synonyms":{"shape":"SynonymOptionsStatus"} + }, + "documentation":"

A response message that contains the status of updated synonym options.

" + }, + "UpdateTimestamp":{"type":"timestamp"} + } +} diff --git a/apis/cloudsearch-2011-02-01.paginators.json b/apis/cloudsearch-2011-02-01.paginators.json new file mode 100644 index 0000000000..52164452b6 --- /dev/null +++ b/apis/cloudsearch-2011-02-01.paginators.json @@ -0,0 +1,13 @@ +{ + "pagination": { + "DescribeDomains": { + "result_key": "DomainStatusList" + }, + "DescribeIndexFields": { + "result_key": "IndexFields" + }, + "DescribeRankExpressions": { + "result_key": "RankExpressions" + } + } +} diff --git a/apis/cloudsearch-2013-01-01.api.json b/apis/cloudsearch-2013-01-01.api.json new file mode 100644 index 0000000000..19940f81c1 --- /dev/null +++ b/apis/cloudsearch-2013-01-01.api.json @@ -0,0 +1,1064 @@ +{ + "metadata": { + "apiVersion": "2013-01-01", + "endpointPrefix": "cloudsearch", + "serviceFullName": "Amazon CloudSearch", + "signatureVersion": "v4", + "xmlNamespace": "http://cloudsearch.amazonaws.com/doc/2013-01-01/", + "protocol": "query" + }, + "operations": { + "BuildSuggesters": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "BuildSuggestersResult", + "type": "structure", + "members": { + "FieldNames": { + "shape": "S4" + } + } + } + }, + "CreateDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "CreateDomainResult", + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S8" + } + } + } + }, + "DefineAnalysisScheme": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "AnalysisScheme" + ], + "members": { + "DomainName": {}, + "AnalysisScheme": { + "shape": "Si" + } + } + }, + "output": { + "resultWrapper": "DefineAnalysisSchemeResult", + "type": "structure", + "required": [ + "AnalysisScheme" + ], + "members": { + "AnalysisScheme": { + "shape": "So" + } + } + } + }, + "DefineExpression": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Expression" + ], + "members": { + "DomainName": {}, + "Expression": { + "shape": "Su" + } + } + }, + "output": { + "resultWrapper": "DefineExpressionResult", + "type": "structure", + "required": [ + "Expression" + ], + "members": { + "Expression": { + "shape": "Sx" + } + } + } + }, + "DefineIndexField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "IndexField" + ], + "members": { + "DomainName": {}, + "IndexField": { + "shape": "Sz" + } + } + }, + "output": { + "resultWrapper": "DefineIndexFieldResult", + "type": "structure", + "required": [ + "IndexField" + ], + "members": { + "IndexField": { + "shape": "S1i" + } + } + } + }, + "DefineSuggester": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Suggester" + ], + "members": { + "DomainName": {}, + "Suggester": { + "shape": "S1k" + } + } + }, + "output": { + "resultWrapper": "DefineSuggesterResult", + "type": "structure", + "required": [ + "Suggester" + ], + "members": { + "Suggester": { + "shape": "S1o" + } + } + } + }, + "DeleteAnalysisScheme": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "AnalysisSchemeName" + ], + "members": { + "DomainName": {}, + "AnalysisSchemeName": {} + } + }, + "output": { + "resultWrapper": "DeleteAnalysisSchemeResult", + "type": "structure", + "required": [ + "AnalysisScheme" + ], + "members": { + "AnalysisScheme": { + "shape": "So" + } + } + } + }, + "DeleteDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DeleteDomainResult", + "type": "structure", + "members": { + "DomainStatus": { + "shape": "S8" + } + } + } + }, + "DeleteExpression": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ExpressionName" + ], + "members": { + "DomainName": {}, + "ExpressionName": {} + } + }, + "output": { + "resultWrapper": "DeleteExpressionResult", + "type": "structure", + "required": [ + "Expression" + ], + "members": { + "Expression": { + "shape": "Sx" + } + } + } + }, + "DeleteIndexField": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "IndexFieldName" + ], + "members": { + "DomainName": {}, + "IndexFieldName": {} + } + }, + "output": { + "resultWrapper": "DeleteIndexFieldResult", + "type": "structure", + "required": [ + "IndexField" + ], + "members": { + "IndexField": { + "shape": "S1i" + } + } + } + }, + "DeleteSuggester": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "SuggesterName" + ], + "members": { + "DomainName": {}, + "SuggesterName": {} + } + }, + "output": { + "resultWrapper": "DeleteSuggesterResult", + "type": "structure", + "required": [ + "Suggester" + ], + "members": { + "Suggester": { + "shape": "S1o" + } + } + } + }, + "DescribeAnalysisSchemes": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AnalysisSchemeNames": { + "shape": "S4" + }, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeAnalysisSchemesResult", + "type": "structure", + "required": [ + "AnalysisSchemes" + ], + "members": { + "AnalysisSchemes": { + "type": "list", + "member": { + "shape": "So" + } + } + } + } + }, + "DescribeAvailabilityOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeAvailabilityOptionsResult", + "type": "structure", + "members": { + "AvailabilityOptions": { + "shape": "S24" + } + } + } + }, + "DescribeDomains": { + "input": { + "type": "structure", + "members": { + "DomainNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeDomainsResult", + "type": "structure", + "required": [ + "DomainStatusList" + ], + "members": { + "DomainStatusList": { + "type": "list", + "member": { + "shape": "S8" + } + } + } + } + }, + "DescribeExpressions": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "ExpressionNames": { + "shape": "S4" + }, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeExpressionsResult", + "type": "structure", + "required": [ + "Expressions" + ], + "members": { + "Expressions": { + "type": "list", + "member": { + "shape": "Sx" + } + } + } + } + }, + "DescribeIndexFields": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "FieldNames": { + "shape": "S4" + }, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeIndexFieldsResult", + "type": "structure", + "required": [ + "IndexFields" + ], + "members": { + "IndexFields": { + "type": "list", + "member": { + "shape": "S1i" + } + } + } + } + }, + "DescribeScalingParameters": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DescribeScalingParametersResult", + "type": "structure", + "required": [ + "ScalingParameters" + ], + "members": { + "ScalingParameters": { + "shape": "S2i" + } + } + } + }, + "DescribeServiceAccessPolicies": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeServiceAccessPoliciesResult", + "type": "structure", + "required": [ + "AccessPolicies" + ], + "members": { + "AccessPolicies": { + "shape": "S2n" + } + } + } + }, + "DescribeSuggesters": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "SuggesterNames": { + "shape": "S4" + }, + "Deployed": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeSuggestersResult", + "type": "structure", + "required": [ + "Suggesters" + ], + "members": { + "Suggesters": { + "type": "list", + "member": { + "shape": "S1o" + } + } + } + } + }, + "IndexDocuments": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "IndexDocumentsResult", + "type": "structure", + "members": { + "FieldNames": { + "shape": "S4" + } + } + } + }, + "ListDomainNames": { + "output": { + "resultWrapper": "ListDomainNamesResult", + "type": "structure", + "members": { + "DomainNames": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "UpdateAvailabilityOptions": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "MultiAZ" + ], + "members": { + "DomainName": {}, + "MultiAZ": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "UpdateAvailabilityOptionsResult", + "type": "structure", + "members": { + "AvailabilityOptions": { + "shape": "S24" + } + } + } + }, + "UpdateScalingParameters": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ScalingParameters" + ], + "members": { + "DomainName": {}, + "ScalingParameters": { + "shape": "S2j" + } + } + }, + "output": { + "resultWrapper": "UpdateScalingParametersResult", + "type": "structure", + "required": [ + "ScalingParameters" + ], + "members": { + "ScalingParameters": { + "shape": "S2i" + } + } + } + }, + "UpdateServiceAccessPolicies": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "AccessPolicies" + ], + "members": { + "DomainName": {}, + "AccessPolicies": {} + } + }, + "output": { + "resultWrapper": "UpdateServiceAccessPoliciesResult", + "type": "structure", + "required": [ + "AccessPolicies" + ], + "members": { + "AccessPolicies": { + "shape": "S2n" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "list", + "member": {} + }, + "S8": { + "type": "structure", + "required": [ + "DomainId", + "DomainName", + "RequiresIndexDocuments" + ], + "members": { + "DomainId": {}, + "DomainName": {}, + "ARN": {}, + "Created": { + "type": "boolean" + }, + "Deleted": { + "type": "boolean" + }, + "DocService": { + "shape": "Sc" + }, + "SearchService": { + "shape": "Sc" + }, + "RequiresIndexDocuments": { + "type": "boolean" + }, + "Processing": { + "type": "boolean" + }, + "SearchInstanceType": {}, + "SearchPartitionCount": { + "type": "integer" + }, + "SearchInstanceCount": { + "type": "integer" + } + } + }, + "Sc": { + "type": "structure", + "members": { + "Endpoint": {} + } + }, + "Si": { + "type": "structure", + "required": [ + "AnalysisSchemeName", + "AnalysisSchemeLanguage" + ], + "members": { + "AnalysisSchemeName": {}, + "AnalysisSchemeLanguage": {}, + "AnalysisOptions": { + "type": "structure", + "members": { + "Synonyms": {}, + "Stopwords": {}, + "StemmingDictionary": {}, + "AlgorithmicStemming": {} + } + } + } + }, + "So": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Si" + }, + "Status": { + "shape": "Sp" + } + } + }, + "Sp": { + "type": "structure", + "required": [ + "CreationDate", + "UpdateDate", + "State" + ], + "members": { + "CreationDate": { + "type": "timestamp" + }, + "UpdateDate": { + "type": "timestamp" + }, + "UpdateVersion": { + "type": "integer" + }, + "State": {}, + "PendingDeletion": { + "type": "boolean" + } + } + }, + "Su": { + "type": "structure", + "required": [ + "ExpressionName", + "ExpressionValue" + ], + "members": { + "ExpressionName": {}, + "ExpressionValue": {} + } + }, + "Sx": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Su" + }, + "Status": { + "shape": "Sp" + } + } + }, + "Sz": { + "type": "structure", + "required": [ + "IndexFieldName", + "IndexFieldType" + ], + "members": { + "IndexFieldName": {}, + "IndexFieldType": {}, + "IntOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "long" + }, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "DoubleOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "double" + }, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "LiteralOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "TextOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceField": {}, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + }, + "HighlightEnabled": { + "type": "boolean" + }, + "AnalysisScheme": {} + } + }, + "DateOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "LatLonOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceField": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + }, + "SortEnabled": { + "type": "boolean" + } + } + }, + "IntArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "long" + }, + "SourceFields": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + } + } + }, + "DoubleArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": { + "type": "double" + }, + "SourceFields": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + } + } + }, + "LiteralArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceFields": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + } + } + }, + "TextArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceFields": {}, + "ReturnEnabled": { + "type": "boolean" + }, + "HighlightEnabled": { + "type": "boolean" + }, + "AnalysisScheme": {} + } + }, + "DateArrayOptions": { + "type": "structure", + "members": { + "DefaultValue": {}, + "SourceFields": {}, + "FacetEnabled": { + "type": "boolean" + }, + "SearchEnabled": { + "type": "boolean" + }, + "ReturnEnabled": { + "type": "boolean" + } + } + } + } + }, + "S1i": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "Sz" + }, + "Status": { + "shape": "Sp" + } + } + }, + "S1k": { + "type": "structure", + "required": [ + "SuggesterName", + "DocumentSuggesterOptions" + ], + "members": { + "SuggesterName": {}, + "DocumentSuggesterOptions": { + "type": "structure", + "required": [ + "SourceField" + ], + "members": { + "SourceField": {}, + "FuzzyMatching": {}, + "SortExpression": {} + } + } + } + }, + "S1o": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "S1k" + }, + "Status": { + "shape": "Sp" + } + } + }, + "S24": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "type": "boolean" + }, + "Status": { + "shape": "Sp" + } + } + }, + "S2i": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": { + "shape": "S2j" + }, + "Status": { + "shape": "Sp" + } + } + }, + "S2j": { + "type": "structure", + "members": { + "DesiredInstanceType": {}, + "DesiredReplicationCount": { + "type": "integer" + }, + "DesiredPartitionCount": { + "type": "integer" + } + } + }, + "S2n": { + "type": "structure", + "required": [ + "Options", + "Status" + ], + "members": { + "Options": {}, + "Status": { + "shape": "Sp" + } + } + } + } +} \ No newline at end of file diff --git a/apis/cloudsearch-2013-01-01.full.json b/apis/cloudsearch-2013-01-01.full.json new file mode 100644 index 0000000000..c57e130e3a --- /dev/null +++ b/apis/cloudsearch-2013-01-01.full.json @@ -0,0 +1,2655 @@ +{ + "metadata":{ + "apiVersion":"2013-01-01", + "endpointPrefix":"cloudsearch", + "serviceFullName":"Amazon CloudSearch", + "signatureVersion":"v4", + "xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2013-01-01/", + "protocol":"query" + }, + "documentation":"Amazon CloudSearch Configuration Service

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

", + "operations":{ + "BuildSuggesters":{ + "name":"BuildSuggesters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"BuildSuggestersRequest", + "documentation":"

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

" + }, + "output":{ + "shape":"BuildSuggestersResponse", + "documentation":"

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

", + "resultWrapper":"BuildSuggestersResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Indexes the search suggestions.

" + }, + "CreateDomain":{ + "name":"CreateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDomainRequest", + "documentation":"

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

" + }, + "output":{ + "shape":"CreateDomainResponse", + "documentation":"

The result of a CreateDomainRequest. Contains the status of a newly created domain.

", + "resultWrapper":"CreateDomainResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + } + ], + "documentation":"

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

" + }, + "DefineAnalysisScheme":{ + "name":"DefineAnalysisScheme", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DefineAnalysisSchemeRequest", + "documentation":"

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

" + }, + "output":{ + "shape":"DefineAnalysisSchemeResponse", + "documentation":"

The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

", + "resultWrapper":"DefineAnalysisSchemeResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" + }, + "DefineExpression":{ + "name":"DefineExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DefineExpressionRequest", + "documentation":"

Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

" + }, + "output":{ + "shape":"DefineExpressionResponse", + "documentation":"

The result of a DefineExpression request. Contains the status of the newly-configured expression.

", + "resultWrapper":"DefineExpressionResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "DefineIndexField":{ + "name":"DefineIndexField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DefineIndexFieldRequest", + "documentation":"

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

" + }, + "output":{ + "shape":"DefineIndexFieldResponse", + "documentation":"

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

", + "resultWrapper":"DefineIndexFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" + }, + "DefineSuggester":{ + "name":"DefineSuggester", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DefineSuggesterRequest", + "documentation":"

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

" + }, + "output":{ + "shape":"DefineSuggesterResponse", + "documentation":"

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

", + "resultWrapper":"DefineSuggesterResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteAnalysisScheme":{ + "name":"DeleteAnalysisScheme", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteAnalysisSchemeRequest", + "documentation":"

Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

" + }, + "output":{ + "shape":"DeleteAnalysisSchemeResponse", + "documentation":"

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

", + "resultWrapper":"DeleteAnalysisSchemeResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDomainRequest", + "documentation":"

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

" + }, + "output":{ + "shape":"DeleteDomainResponse", + "documentation":"

The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

", + "resultWrapper":"DeleteDomainResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + } + ], + "documentation":"

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteExpression":{ + "name":"DeleteExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteExpressionRequest", + "documentation":"

Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

" + }, + "output":{ + "shape":"DeleteExpressionResponse", + "documentation":"

The result of a DeleteExpression request. Specifies the expression being deleted.

", + "resultWrapper":"DeleteExpressionResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteIndexField":{ + "name":"DeleteIndexField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteIndexFieldRequest", + "documentation":"

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

" + }, + "output":{ + "shape":"DeleteIndexFieldResponse", + "documentation":"

The result of a DeleteIndexField request.

", + "resultWrapper":"DeleteIndexFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteSuggester":{ + "name":"DeleteSuggester", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteSuggesterRequest", + "documentation":"

Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

" + }, + "output":{ + "shape":"DeleteSuggesterResponse", + "documentation":"

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

", + "resultWrapper":"DeleteSuggesterResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeAnalysisSchemes":{ + "name":"DescribeAnalysisSchemes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeAnalysisSchemesRequest", + "documentation":"

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeAnalysisSchemesResponse", + "documentation":"

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

", + "resultWrapper":"DescribeAnalysisSchemesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeAvailabilityOptions":{ + "name":"DescribeAvailabilityOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeAvailabilityOptionsRequest", + "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeAvailabilityOptionsResponse", + "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

", + "resultWrapper":"DescribeAvailabilityOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"DisabledOperationException", + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + } + ], + "documentation":"

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeDomains":{ + "name":"DescribeDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDomainsRequest", + "documentation":"

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

" + }, + "output":{ + "shape":"DescribeDomainsResponse", + "documentation":"

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

", + "resultWrapper":"DescribeDomainsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + } + ], + "documentation":"

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeExpressions":{ + "name":"DescribeExpressions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeExpressionsRequest", + "documentation":"

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeExpressionsResponse", + "documentation":"

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

", + "resultWrapper":"DescribeExpressionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeIndexFields":{ + "name":"DescribeIndexFields", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeIndexFieldsRequest", + "documentation":"

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeIndexFieldsResponse", + "documentation":"

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

", + "resultWrapper":"DescribeIndexFieldsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeScalingParameters":{ + "name":"DescribeScalingParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeScalingParametersRequest", + "documentation":"

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

" + }, + "output":{ + "shape":"DescribeScalingParametersResponse", + "documentation":"

The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

", + "resultWrapper":"DescribeScalingParametersResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeServiceAccessPolicies":{ + "name":"DescribeServiceAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeServiceAccessPoliciesRequest", + "documentation":"

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeServiceAccessPoliciesResponse", + "documentation":"

The result of a DescribeServiceAccessPolicies request.

", + "resultWrapper":"DescribeServiceAccessPoliciesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeSuggesters":{ + "name":"DescribeSuggesters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSuggestersRequest", + "documentation":"

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeSuggestersResponse", + "documentation":"

The result of a DescribeSuggesters request.

", + "resultWrapper":"DescribeSuggestersResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" + }, + "IndexDocuments":{ + "name":"IndexDocuments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"IndexDocumentsRequest", + "documentation":"

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

" + }, + "output":{ + "shape":"IndexDocumentsResponse", + "documentation":"

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

", + "resultWrapper":"IndexDocumentsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

" + }, + "ListDomainNames":{ + "name":"ListDomainNames", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"ListDomainNamesResponse", + "documentation":"

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

", + "resultWrapper":"ListDomainNamesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + } + ], + "documentation":"

Lists all search domains owned by an account.

" + }, + "UpdateAvailabilityOptions":{ + "name":"UpdateAvailabilityOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateAvailabilityOptionsRequest", + "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" + }, + "output":{ + "shape":"UpdateAvailabilityOptionsResponse", + "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

", + "resultWrapper":"UpdateAvailabilityOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"DisabledOperationException", + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + } + ], + "documentation":"

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" + }, + "UpdateScalingParameters":{ + "name":"UpdateScalingParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateScalingParametersRequest", + "documentation":"

Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

" + }, + "output":{ + "shape":"UpdateScalingParametersResponse", + "documentation":"

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

", + "resultWrapper":"UpdateScalingParametersResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + } + ], + "documentation":"

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

" + }, + "UpdateServiceAccessPolicies":{ + "name":"UpdateServiceAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateServiceAccessPoliciesRequest", + "documentation":"

Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

" + }, + "output":{ + "shape":"UpdateServiceAccessPoliciesResponse", + "documentation":"

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

", + "resultWrapper":"UpdateServiceAccessPoliciesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + } + ], + "documentation":"

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

" + } + }, + "shapes":{ + "APIVersion":{ + "type":"string", + "documentation":"

The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.

" + }, + "ARN":{ + "type":"string", + "documentation":"

The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" + }, + "AccessPoliciesStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"PolicyDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

" + }, + "AlgorithmicStemming":{ + "type":"string", + "enum":[ + "none", + "minimal", + "light", + "full" + ] + }, + "AnalysisOptions":{ + "type":"structure", + "members":{ + "Synonyms":{ + "shape":"String", + "documentation":"

A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

" + }, + "Stopwords":{ + "shape":"String", + "documentation":"

A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

" + }, + "StemmingDictionary":{ + "shape":"String", + "documentation":"

A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

" + }, + "AlgorithmicStemming":{ + "shape":"AlgorithmicStemming", + "documentation":"

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

" + } + }, + "documentation":"

Synonyms, stopwords, and stemming options for an analysis scheme.

" + }, + "AnalysisScheme":{ + "type":"structure", + "required":[ + "AnalysisSchemeName", + "AnalysisSchemeLanguage" + ], + "members":{ + "AnalysisSchemeName":{"shape":"FieldName"}, + "AnalysisSchemeLanguage":{"shape":"AnalysisSchemeLanguage"}, + "AnalysisOptions":{"shape":"AnalysisOptions"} + }, + "documentation":"

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, and AlgorithmicStemming.

" + }, + "AnalysisSchemeLanguage":{ + "type":"string", + "enum":[ + "ar", + "bg", + "ca", + "cs", + "da", + "de", + "el", + "en", + "es", + "eu", + "fa", + "fi", + "fr", + "ga", + "gl", + "he", + "hi", + "hu", + "hy", + "id", + "it", + "ja", + "ko", + "lv", + "mul", + "nl", + "no", + "pt", + "ro", + "ru", + "sv", + "th", + "tr", + "zh-Hans", + "zh-Hant" + ], + "documentation":"

An IETF RFC 4646 language code or mul for multiple languages.

" + }, + "AnalysisSchemeStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"AnalysisScheme"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The status and configuration of an AnalysisScheme.

" + }, + "AnalysisSchemeStatusList":{ + "type":"list", + "member":{"shape":"AnalysisSchemeStatus"}, + "documentation":"

A list of the analysis schemes configured for a domain.

" + }, + "AvailabilityOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"MultiAZ", + "documentation":"

The availability options configured for the domain.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The status and configuration of the domain's availability options.

" + }, + "BaseException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + "Boolean":{"type":"boolean"}, + "BuildSuggestersRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + }, + "documentation":"

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

" + }, + "BuildSuggestersResponse":{ + "type":"structure", + "members":{ + "FieldNames":{"shape":"FieldNameList"} + }, + "documentation":"

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

" + }, + "CreateDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

" + } + }, + "documentation":"

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

" + }, + "CreateDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{"shape":"DomainStatus"} + }, + "documentation":"

The result of a CreateDomainRequest. Contains the status of a newly created domain.

" + }, + "DateArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + } + }, + "documentation":"

Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

" + }, + "DateOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceField":{"shape":"FieldName"}, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

" + }, + "DefineAnalysisSchemeRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AnalysisScheme" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AnalysisScheme":{"shape":"AnalysisScheme"} + }, + "documentation":"

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

" + }, + "DefineAnalysisSchemeResponse":{ + "type":"structure", + "required":["AnalysisScheme"], + "members":{ + "AnalysisScheme":{"shape":"AnalysisSchemeStatus"} + }, + "documentation":"

The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

" + }, + "DefineExpressionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Expression" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Expression":{"shape":"Expression"} + }, + "documentation":"

Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

" + }, + "DefineExpressionResponse":{ + "type":"structure", + "required":["Expression"], + "members":{ + "Expression":{"shape":"ExpressionStatus"} + }, + "documentation":"

The result of a DefineExpression request. Contains the status of the newly-configured expression.

" + }, + "DefineIndexFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "IndexField" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IndexField":{ + "shape":"IndexField", + "documentation":"

The index field and field options you want to configure.

" + } + }, + "documentation":"

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

" + }, + "DefineIndexFieldResponse":{ + "type":"structure", + "required":["IndexField"], + "members":{ + "IndexField":{"shape":"IndexFieldStatus"} + }, + "documentation":"

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

" + }, + "DefineSuggesterRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Suggester" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Suggester":{"shape":"Suggester"} + }, + "documentation":"

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

" + }, + "DefineSuggesterResponse":{ + "type":"structure", + "required":["Suggester"], + "members":{ + "Suggester":{"shape":"SuggesterStatus"} + }, + "documentation":"

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

" + }, + "DeleteAnalysisSchemeRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AnalysisSchemeName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AnalysisSchemeName":{ + "shape":"FieldName", + "documentation":"

The name of the analysis scheme you want to delete.

" + } + }, + "documentation":"

Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

" + }, + "DeleteAnalysisSchemeResponse":{ + "type":"structure", + "required":["AnalysisScheme"], + "members":{ + "AnalysisScheme":{ + "shape":"AnalysisSchemeStatus", + "documentation":"

The status of the analysis scheme being deleted.

" + } + }, + "documentation":"

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

" + }, + "DeleteDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to permanently delete.

" + } + }, + "documentation":"

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

" + }, + "DeleteDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{"shape":"DomainStatus"} + }, + "documentation":"

The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

" + }, + "DeleteExpressionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ExpressionName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "ExpressionName":{ + "shape":"FieldName", + "documentation":"

The name of the Expression to delete.

" + } + }, + "documentation":"

Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

" + }, + "DeleteExpressionResponse":{ + "type":"structure", + "required":["Expression"], + "members":{ + "Expression":{ + "shape":"ExpressionStatus", + "documentation":"

The status of the expression being deleted.

" + } + }, + "documentation":"

The result of a DeleteExpression request. Specifies the expression being deleted.

" + }, + "DeleteIndexFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "IndexFieldName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IndexFieldName":{ + "shape":"FieldName", + "documentation":"

The name of the index field your want to remove from the domain's indexing options.

" + } + }, + "documentation":"

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

" + }, + "DeleteIndexFieldResponse":{ + "type":"structure", + "required":["IndexField"], + "members":{ + "IndexField":{ + "shape":"IndexFieldStatus", + "documentation":"

The status of the index field being deleted.

" + } + }, + "documentation":"

The result of a DeleteIndexField request.

" + }, + "DeleteSuggesterRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SuggesterName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "SuggesterName":{ + "shape":"FieldName", + "documentation":"

Specifies the name of the suggester you want to delete.

" + } + }, + "documentation":"

Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

" + }, + "DeleteSuggesterResponse":{ + "type":"structure", + "required":["Suggester"], + "members":{ + "Suggester":{ + "shape":"SuggesterStatus", + "documentation":"

The status of the suggester being deleted.

" + } + }, + "documentation":"

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

" + }, + "DescribeAnalysisSchemesRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "AnalysisSchemeNames":{ + "shape":"FieldNameList", + "documentation":"

The analysis schemes you want to describe.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeAnalysisSchemesResponse":{ + "type":"structure", + "required":["AnalysisSchemes"], + "members":{ + "AnalysisSchemes":{ + "shape":"AnalysisSchemeStatusList", + "documentation":"

The analysis scheme descriptions.

" + } + }, + "documentation":"

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

" + }, + "DescribeAvailabilityOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeAvailabilityOptionsResponse":{ + "type":"structure", + "members":{ + "AvailabilityOptions":{ + "shape":"AvailabilityOptionsStatus", + "documentation":"

The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

" + } + }, + "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

" + }, + "DescribeDomainsRequest":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainNameList", + "documentation":"

The names of the domains you want to include in the response.

" + } + }, + "documentation":"

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

" + }, + "DescribeDomainsResponse":{ + "type":"structure", + "required":["DomainStatusList"], + "members":{ + "DomainStatusList":{"shape":"DomainStatusList"} + }, + "documentation":"

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

" + }, + "DescribeExpressionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "ExpressionNames":{ + "shape":"FieldNameList", + "documentation":"

Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeExpressionsResponse":{ + "type":"structure", + "required":["Expressions"], + "members":{ + "Expressions":{ + "shape":"ExpressionStatusList", + "documentation":"

The expressions configured for the domain.

" + } + }, + "documentation":"

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

" + }, + "DescribeIndexFieldsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "FieldNames":{ + "shape":"FieldNameList", + "documentation":"

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeIndexFieldsResponse":{ + "type":"structure", + "required":["IndexFields"], + "members":{ + "IndexFields":{ + "shape":"IndexFieldStatusList", + "documentation":"

The index fields configured for the domain.

" + } + }, + "documentation":"

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

" + }, + "DescribeScalingParametersRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + }, + "documentation":"

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

" + }, + "DescribeScalingParametersResponse":{ + "type":"structure", + "required":["ScalingParameters"], + "members":{ + "ScalingParameters":{"shape":"ScalingParametersStatus"} + }, + "documentation":"

The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

" + }, + "DescribeServiceAccessPoliciesRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeServiceAccessPoliciesResponse":{ + "type":"structure", + "required":["AccessPolicies"], + "members":{ + "AccessPolicies":{ + "shape":"AccessPoliciesStatus", + "documentation":"

The access rules configured for the domain specified in the request.

" + } + }, + "documentation":"

The result of a DescribeServiceAccessPolicies request.

" + }, + "DescribeSuggestersRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "SuggesterNames":{ + "shape":"FieldNameList", + "documentation":"

The suggesters you want to describe.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeSuggestersResponse":{ + "type":"structure", + "required":["Suggesters"], + "members":{ + "Suggesters":{ + "shape":"SuggesterStatusList", + "documentation":"

The suggesters configured for the domain specified in the request.

" + } + }, + "documentation":"

The result of a DescribeSuggesters request.

" + }, + "DisabledOperationException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + }, + "DocumentSuggesterOptions":{ + "type":"structure", + "required":["SourceField"], + "members":{ + "SourceField":{ + "shape":"FieldName", + "documentation":"

The name of the index field you want to use for suggestions.

" + }, + "FuzzyMatching":{ + "shape":"SuggesterFuzzyMatching", + "documentation":"

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

" + }, + "SortExpression":{ + "shape":"String", + "documentation":"

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

" + } + }, + "documentation":"

Options for a search suggester.

" + }, + "DomainId":{ + "type":"string", + "min":1, + "max":64, + "documentation":"

An internally generated unique identifier for a domain.

" + }, + "DomainName":{ + "type":"string", + "min":3, + "max":28, + "pattern":"[a-z][a-z0-9\\-]+", + "documentation":"

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

" + }, + "DomainNameList":{ + "type":"list", + "member":{"shape":"DomainName"}, + "documentation":"

A list of domain names.

" + }, + "DomainNameMap":{ + "type":"map", + "key":{"shape":"DomainName"}, + "value":{"shape":"APIVersion"}, + "documentation":"

A collection of domain names.

" + }, + "DomainStatus":{ + "type":"structure", + "required":[ + "DomainId", + "DomainName", + "RequiresIndexDocuments" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "DomainName":{"shape":"DomainName"}, + "ARN":{"shape":"ARN"}, + "Created":{ + "shape":"Boolean", + "documentation":"

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

" + }, + "Deleted":{ + "shape":"Boolean", + "documentation":"

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

" + }, + "DocService":{ + "shape":"ServiceEndpoint", + "documentation":"

The service endpoint for updating documents in a search domain.

" + }, + "SearchService":{ + "shape":"ServiceEndpoint", + "documentation":"

The service endpoint for requesting search results from a search domain.

" + }, + "RequiresIndexDocuments":{ + "shape":"Boolean", + "documentation":"

True if IndexDocuments needs to be called to activate the current domain configuration.

" + }, + "Processing":{ + "shape":"Boolean", + "documentation":"

True if processing is being done to activate the current domain configuration.

" + }, + "SearchInstanceType":{ + "shape":"SearchInstanceType", + "documentation":"

The instance type that is being used to process search requests.

" + }, + "SearchPartitionCount":{ + "shape":"PartitionCount", + "documentation":"

The number of partitions across which the search index is spread.

" + }, + "SearchInstanceCount":{ + "shape":"InstanceCount", + "documentation":"

The number of search instances that are available to process search requests.

" + } + }, + "documentation":"

The current status of the search domain.

" + }, + "DomainStatusList":{ + "type":"list", + "member":{"shape":"DomainStatus"}, + "documentation":"

A list that contains the status of each requested domain.

" + }, + "Double":{"type":"double"}, + "DoubleArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"Double", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + } + }, + "documentation":"

Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

" + }, + "DoubleOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"Double", + "documentation":"

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

" + }, + "SourceField":{ + "shape":"FieldName", + "documentation":"

The name of the source field to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

" + }, + "ErrorCode":{ + "type":"string", + "documentation":"

A machine-parsable string error or warning code.

" + }, + "ErrorMessage":{ + "type":"string", + "documentation":"

A human-readable string error or warning message.

" + }, + "Expression":{ + "type":"structure", + "required":[ + "ExpressionName", + "ExpressionValue" + ], + "members":{ + "ExpressionName":{"shape":"FieldName"}, + "ExpressionValue":{"shape":"ExpressionValue"} + }, + "documentation":"

A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

" + }, + "ExpressionStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"Expression", + "documentation":"

The expression that is evaluated for sorting while processing a search request.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of an Expression and its current status.

" + }, + "ExpressionStatusList":{ + "type":"list", + "member":{"shape":"ExpressionStatus"}, + "documentation":"

Contains the status of multiple expressions.

" + }, + "ExpressionValue":{ + "type":"string", + "min":1, + "max":10240, + "documentation":"

The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "FieldName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-z][a-z0-9_]*", + "documentation":"

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name \"score\" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

" + }, + "FieldNameCommaList":{ + "type":"string", + "pattern":"\\s*[a-z][a-z0-9_]*\\s*(,\\s*[a-z][a-z0-9_]*\\s*)*" + }, + "FieldNameList":{ + "type":"list", + "member":{"shape":"FieldName"}, + "documentation":"

A list of field names.

" + }, + "FieldValue":{ + "type":"string", + "min":0, + "max":1024, + "documentation":"

The value of a field attribute.

" + }, + "IndexDocumentsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + }, + "documentation":"

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

" + }, + "IndexDocumentsResponse":{ + "type":"structure", + "members":{ + "FieldNames":{ + "shape":"FieldNameList", + "documentation":"

The names of the fields that are currently being indexed.

" + } + }, + "documentation":"

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

" + }, + "IndexField":{ + "type":"structure", + "required":[ + "IndexFieldName", + "IndexFieldType" + ], + "members":{ + "IndexFieldName":{ + "shape":"FieldName", + "documentation":"

The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name \"score\" is reserved and cannot be specified as field or expression name.

" + }, + "IndexFieldType":{"shape":"IndexFieldType"}, + "IntOptions":{"shape":"IntOptions"}, + "DoubleOptions":{"shape":"DoubleOptions"}, + "LiteralOptions":{"shape":"LiteralOptions"}, + "TextOptions":{"shape":"TextOptions"}, + "DateOptions":{"shape":"DateOptions"}, + "LatLonOptions":{"shape":"LatLonOptions"}, + "IntArrayOptions":{"shape":"IntArrayOptions"}, + "DoubleArrayOptions":{"shape":"DoubleArrayOptions"}, + "LiteralArrayOptions":{"shape":"LiteralArrayOptions"}, + "TextArrayOptions":{"shape":"TextArrayOptions"}, + "DateArrayOptions":{"shape":"DateArrayOptions"} + }, + "documentation":"

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

" + }, + "IndexFieldStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"IndexField"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of an IndexField and its current status.

" + }, + "IndexFieldStatusList":{ + "type":"list", + "member":{"shape":"IndexFieldStatus"}, + "documentation":"

Contains the status of multiple index fields.

" + }, + "IndexFieldType":{ + "type":"string", + "enum":[ + "int", + "double", + "literal", + "text", + "date", + "latlon", + "int-array", + "double-array", + "literal-array", + "text-array", + "date-array" + ], + "documentation":"

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" + }, + "InstanceCount":{ + "type":"integer", + "min":1 + }, + "IntArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"Long", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + } + }, + "documentation":"

Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

" + }, + "IntOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"Long", + "documentation":"A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document." + }, + "SourceField":{ + "shape":"FieldName", + "documentation":"

The name of the source field to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

" + }, + "InternalException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + "InvalidTypeException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + "LatLonOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceField":{"shape":"FieldName"}, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + "ListDomainNamesResponse":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainNameMap", + "documentation":"

The names of the search domains owned by an account.

" + } + }, + "documentation":"

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

" + }, + "LiteralArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + } + }, + "documentation":"

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

" + }, + "LiteralOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceField":{"shape":"FieldName"}, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

" + }, + "Long":{"type":"long"}, + "MultiAZ":{"type":"boolean"}, + "OptionState":{ + "type":"string", + "enum":[ + "RequiresIndexDocuments", + "Processing", + "Active", + "FailedToValidate" + ], + "documentation":"

The state of processing a change to an option. One of:

" + }, + "OptionStatus":{ + "type":"structure", + "required":[ + "CreationDate", + "UpdateDate", + "State" + ], + "members":{ + "CreationDate":{ + "shape":"UpdateTimestamp", + "documentation":"

A timestamp for when this option was created.

" + }, + "UpdateDate":{ + "shape":"UpdateTimestamp", + "documentation":"

A timestamp for when this option was last updated.

" + }, + "UpdateVersion":{ + "shape":"UIntValue", + "documentation":"

A unique integer that indicates when this option was last updated.

" + }, + "State":{ + "shape":"OptionState", + "documentation":"

The state of processing a change to an option. Possible values:

" + }, + "PendingDeletion":{ + "shape":"Boolean", + "documentation":"

Indicates that the option will be deleted once processing is complete.

" + } + }, + "documentation":"

The status of domain configuration option.

" + }, + "PartitionCount":{ + "type":"integer", + "min":1, + "documentation":"

The number of partitions used to hold the domain's index.

" + }, + "PartitionInstanceType":{ + "type":"string", + "enum":[ + "search.m1.small", + "search.m1.large", + "search.m2.xlarge", + "search.m2.2xlarge" + ], + "documentation":"

The instance type (such as search.m1.small) on which an index partition is hosted.

" + }, + "PolicyDocument":{ + "type":"string", + "documentation":"

Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + "ScalingParameters":{ + "type":"structure", + "members":{ + "DesiredInstanceType":{ + "shape":"PartitionInstanceType", + "documentation":"

The instance type that you want to preconfigure for your domain. For example, search.m1.small.

" + }, + "DesiredReplicationCount":{ + "shape":"UIntValue", + "documentation":"

The number of replicas you want to preconfigure for each index partition.

" + }, + "DesiredPartitionCount":{ + "shape":"UIntValue", + "documentation":"

The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

" + } + }, + "documentation":"

The desired instance type and desired number of replicas of each index partition.

" + }, + "ScalingParametersStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"ScalingParameters"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The status and configuration of a search domain's scaling parameters.

" + }, + "SearchInstanceType":{ + "type":"string", + "documentation":"

The instance type (such as search.m1.small) that is being used to process search requests.

" + }, + "ServiceEndpoint":{ + "type":"structure", + "members":{ + "Endpoint":{"shape":"ServiceUrl"} + }, + "documentation":"

The endpoint to which service requests can be submitted.

" + }, + "ServiceUrl":{ + "type":"string", + "documentation":"

The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

" + }, + "String":{"type":"string"}, + "Suggester":{ + "type":"structure", + "required":[ + "SuggesterName", + "DocumentSuggesterOptions" + ], + "members":{ + "SuggesterName":{"shape":"FieldName"}, + "DocumentSuggesterOptions":{"shape":"DocumentSuggesterOptions"} + }, + "documentation":"

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

" + }, + "SuggesterFuzzyMatching":{ + "type":"string", + "enum":[ + "none", + "low", + "high" + ] + }, + "SuggesterStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"Suggester"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of a Suggester and its current status.

" + }, + "SuggesterStatusList":{ + "type":"list", + "member":{"shape":"SuggesterStatus"}, + "documentation":"

Contains the status of multiple suggesters.

" + }, + "TextArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "HighlightEnabled":{ + "shape":"Boolean", + "documentation":"

Whether highlights can be returned for the field.

" + }, + "AnalysisScheme":{ + "shape":"Word", + "documentation":"

The name of an analysis scheme for a text-array field.

" + } + }, + "documentation":"

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

" + }, + "TextOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceField":{"shape":"FieldName"}, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + }, + "HighlightEnabled":{ + "shape":"Boolean", + "documentation":"

Whether highlights can be returned for the field.

" + }, + "AnalysisScheme":{ + "shape":"Word", + "documentation":"

The name of an analysis scheme for a text field.

" + } + }, + "documentation":"

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

" + }, + "UIntValue":{ + "type":"integer", + "min":0 + }, + "UpdateAvailabilityOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "MultiAZ" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

" + } + }, + "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" + }, + "UpdateAvailabilityOptionsResponse":{ + "type":"structure", + "members":{ + "AvailabilityOptions":{ + "shape":"AvailabilityOptionsStatus", + "documentation":"

The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

" + } + }, + "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

" + }, + "UpdateScalingParametersRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ScalingParameters" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "ScalingParameters":{"shape":"ScalingParameters"} + }, + "documentation":"

Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

" + }, + "UpdateScalingParametersResponse":{ + "type":"structure", + "required":["ScalingParameters"], + "members":{ + "ScalingParameters":{"shape":"ScalingParametersStatus"} + }, + "documentation":"

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

" + }, + "UpdateServiceAccessPoliciesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AccessPolicies" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AccessPolicies":{ + "shape":"PolicyDocument", + "documentation":"

The access rules you want to configure. These rules replace any existing rules.

" + } + }, + "documentation":"

Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

" + }, + "UpdateServiceAccessPoliciesResponse":{ + "type":"structure", + "required":["AccessPolicies"], + "members":{ + "AccessPolicies":{ + "shape":"AccessPoliciesStatus", + "documentation":"

The access rules configured for the domain.

" + } + }, + "documentation":"

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

" + }, + "UpdateTimestamp":{"type":"timestamp"}, + "Word":{ + "type":"string", + "pattern":"[\\S]+" + } + } +} diff --git a/apis/cloudsearch-2013-01-01.paginators.json b/apis/cloudsearch-2013-01-01.paginators.json new file mode 100644 index 0000000000..82fa804ab7 --- /dev/null +++ b/apis/cloudsearch-2013-01-01.paginators.json @@ -0,0 +1,20 @@ +{ + "pagination": { + "DescribeAnalysisSchemes": { + "result_key": "AnalysisSchemes" + }, + "DescribeDomains": { + "result_key": "DomainStatusList" + }, + "DescribeExpressions": { + "result_key": "Expressions" + }, + "DescribeIndexFields": { + "result_key": "IndexFields" + }, + "DescribeSuggesters": { + "result_key": "Suggesters" + } + } +} + diff --git a/apis/cloudsearchdomain-2013-01-01.api.json b/apis/cloudsearchdomain-2013-01-01.api.json new file mode 100644 index 0000000000..17d1c4956c --- /dev/null +++ b/apis/cloudsearchdomain-2013-01-01.api.json @@ -0,0 +1,260 @@ +{ + "metadata": { + "apiVersion": "2013-01-01", + "endpointPrefix": "cloudsearchdomain", + "jsonVersion": "1.1", + "serviceFullName": "Amazon CloudSearch Domain", + "signatureVersion": "v4", + "signingName": "cloudsearch", + "protocol": "rest-json" + }, + "operations": { + "Search": { + "http": { + "method": "GET", + "requestUri": "/2013-01-01/search?format=sdk&pretty=true" + }, + "input": { + "type": "structure", + "required": [ + "query" + ], + "members": { + "cursor": { + "location": "querystring", + "locationName": "cursor" + }, + "expr": { + "location": "querystring", + "locationName": "expr" + }, + "facet": { + "location": "querystring", + "locationName": "facet" + }, + "filterQuery": { + "location": "querystring", + "locationName": "fq" + }, + "highlight": { + "location": "querystring", + "locationName": "highlight" + }, + "partial": { + "location": "querystring", + "locationName": "partial", + "type": "boolean" + }, + "query": { + "location": "querystring", + "locationName": "q" + }, + "queryOptions": { + "location": "querystring", + "locationName": "q.options" + }, + "queryParser": { + "location": "querystring", + "locationName": "q.parser" + }, + "return": { + "location": "querystring", + "locationName": "return" + }, + "size": { + "location": "querystring", + "locationName": "size", + "type": "long" + }, + "sort": { + "location": "querystring", + "locationName": "sort" + }, + "start": { + "location": "querystring", + "locationName": "start", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": { + "type": "structure", + "members": { + "timems": { + "type": "long" + }, + "rid": {} + } + }, + "hits": { + "type": "structure", + "members": { + "found": { + "type": "long" + }, + "start": { + "type": "long" + }, + "cursor": {}, + "hit": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "fields": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": {} + } + }, + "highlights": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + }, + "facets": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "buckets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "value": {}, + "count": { + "type": "long" + } + } + } + } + } + } + } + } + } + }, + "Suggest": { + "http": { + "method": "GET", + "requestUri": "/2013-01-01/suggest?format=sdk&pretty=true" + }, + "input": { + "type": "structure", + "required": [ + "query", + "suggester" + ], + "members": { + "query": { + "location": "querystring", + "locationName": "q" + }, + "suggester": { + "location": "querystring", + "locationName": "suggester" + }, + "size": { + "location": "querystring", + "locationName": "size", + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": { + "type": "structure", + "members": { + "timems": { + "type": "long" + }, + "rid": {} + } + }, + "suggest": { + "type": "structure", + "members": { + "query": {}, + "found": { + "type": "long" + }, + "suggestions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "suggestion": {}, + "score": { + "type": "long" + }, + "id": {} + } + } + } + } + } + } + } + }, + "UploadDocuments": { + "http": { + "requestUri": "/2013-01-01/documents/batch?format=sdk" + }, + "input": { + "type": "structure", + "required": [ + "documents", + "contentType" + ], + "members": { + "documents": { + "type": "blob", + "streaming": true + }, + "contentType": { + "location": "header", + "locationName": "Content-Type" + } + }, + "payload": "documents" + }, + "output": { + "type": "structure", + "members": { + "status": {}, + "adds": { + "type": "long" + }, + "deletes": { + "type": "long" + }, + "warnings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "message": {} + } + } + } + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/apis/cloudsearchdomain-2013-01-01.full.json b/apis/cloudsearchdomain-2013-01-01.full.json new file mode 100644 index 0000000000..69d936c0c6 --- /dev/null +++ b/apis/cloudsearchdomain-2013-01-01.full.json @@ -0,0 +1,510 @@ +{ + "metadata":{ + "apiVersion":"2013-01-01", + "endpointPrefix":"cloudsearchdomain", + "jsonVersion":"1.1", + "serviceFullName":"Amazon CloudSearch Domain", + "signatureVersion":"v4", + "signingName":"cloudsearch", + "protocol":"rest-json" + }, + "documentation":"

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide.

", + "operations":{ + "Search":{ + "name":"Search", + "http":{ + "method":"GET", + "requestUri":"/2013-01-01/search?format=sdk&pretty=true" + }, + "input":{ + "shape":"SearchRequest", + "documentation":"

Container for the parameters to the Search request.

" + }, + "output":{ + "shape":"SearchResponse", + "documentation":"

The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

" + }, + "errors":[ + { + "shape":"SearchException", + "exception":true, + "documentation":"

Information about any problems encountered while processing a search request.

" + } + ], + "documentation":"

Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:

For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

" + }, + "Suggest":{ + "name":"Suggest", + "http":{ + "method":"GET", + "requestUri":"/2013-01-01/suggest?format=sdk&pretty=true" + }, + "input":{ + "shape":"SuggestRequest", + "documentation":"

Container for the parameters to the Suggest request.

" + }, + "output":{ + "shape":"SuggestResponse", + "documentation":"

Contains the response to a Suggest request.

" + }, + "errors":[ + { + "shape":"SearchException", + "exception":true, + "documentation":"

Information about any problems encountered while processing a search request.

" + } + ], + "documentation":"

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

" + }, + "UploadDocuments":{ + "name":"UploadDocuments", + "http":{ + "method":"POST", + "requestUri":"/2013-01-01/documents/batch?format=sdk" + }, + "input":{ + "shape":"UploadDocumentsRequest", + "documentation":"

Container for the parameters to the UploadDocuments request.

" + }, + "output":{ + "shape":"UploadDocumentsResponse", + "documentation":"

Contains the response to an UploadDocuments request.

" + }, + "errors":[ + { + "shape":"DocumentServiceException", + "exception":true, + "documentation":"

Information about any problems encountered while processing an upload request.

" + } + ], + "documentation":"

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.

" + } + }, + "shapes":{ + "Adds":{"type":"long"}, + "Blob":{ + "type":"blob", + "streaming":true + }, + "Bucket":{ + "type":"structure", + "members":{ + "value":{ + "shape":"String", + "documentation":"

The facet value being counted.

" + }, + "count":{ + "shape":"Long", + "documentation":"

The number of hits that contain the facet value in the specified facet field.

" + } + }, + "documentation":"

A container for facet information.

" + }, + "BucketInfo":{ + "type":"structure", + "members":{ + "buckets":{ + "shape":"BucketList", + "documentation":"

A list of the calculated facet values and counts.

" + } + }, + "documentation":"

A container for the calculated facet values and counts.

" + }, + "BucketList":{ + "type":"list", + "member":{"shape":"Bucket"} + }, + "ContentType":{ + "type":"string", + "enum":[ + "application/json", + "application/xml" + ] + }, + "Cursor":{"type":"string"}, + "Deletes":{"type":"long"}, + "DocumentServiceException":{ + "type":"structure", + "members":{ + "status":{ + "shape":"String", + "documentation":"

The return status of a document upload request, error or success.

" + }, + "message":{ + "shape":"String", + "documentation":"

The description of the errors returned by the document service.

" + } + }, + "exception":true, + "documentation":"

Information about any problems encountered while processing an upload request.

" + }, + "DocumentServiceWarning":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The description for a warning returned by the document service.

" + } + }, + "documentation":"

A warning returned by the document service when an issue is discovered while processing an upload request.

" + }, + "DocumentServiceWarnings":{ + "type":"list", + "member":{"shape":"DocumentServiceWarning"} + }, + "Expr":{"type":"string"}, + "Facet":{"type":"string"}, + "Facets":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"BucketInfo"} + }, + "FieldValue":{ + "type":"list", + "member":{"shape":"String"} + }, + "Fields":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"FieldValue"} + }, + "FilterQuery":{"type":"string"}, + "Highlight":{"type":"string"}, + "Highlights":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Hit":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The document ID of a document that matches the search request.

" + }, + "fields":{ + "shape":"Fields", + "documentation":"

The fields returned from a document that matches the search request.

" + }, + "highlights":{ + "shape":"Highlights", + "documentation":"

The highlights returned from a document that matches the search request.

" + } + }, + "documentation":"

Information about a document that matches the search request.

" + }, + "HitList":{ + "type":"list", + "member":{"shape":"Hit"} + }, + "Hits":{ + "type":"structure", + "members":{ + "found":{ + "shape":"Long", + "documentation":"

The total number of documents that match the search request.

" + }, + "start":{ + "shape":"Long", + "documentation":"

The index of the first matching document.

" + }, + "cursor":{ + "shape":"String", + "documentation":"

A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

" + }, + "hit":{ + "shape":"HitList", + "documentation":"

A document that matches the search request.

" + } + }, + "documentation":"

The collection of documents that match the search request.

" + }, + "Long":{"type":"long"}, + "Partial":{"type":"boolean"}, + "Query":{"type":"string"}, + "QueryOptions":{"type":"string"}, + "QueryParser":{ + "type":"string", + "enum":[ + "simple", + "structured", + "lucene", + "dismax" + ] + }, + "Return":{"type":"string"}, + "SearchException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

A description of the error returned by the search service.

" + } + }, + "exception":true, + "documentation":"

Information about any problems encountered while processing a search request.

" + }, + "SearchRequest":{ + "type":"structure", + "required":["query"], + "members":{ + "cursor":{ + "shape":"Cursor", + "location":"querystring", + "locationName":"cursor", + "documentation":"

Retrieves a cursor value you can use to page through large result sets. Use the size parameter to control the number of hits to include in each response. You can specify either the cursor or start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to initial. In subsequent requests, specify the cursor value returned in the hits section of the response.

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

" + }, + "expr":{ + "shape":"Expr", + "location":"querystring", + "locationName":"expr", + "documentation":"

Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields.

For more information about defining and using expressions, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "facet":{ + "shape":"Facet", + "location":"querystring", + "locationName":"facet", + "documentation":"

Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form {\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}.

You can specify the following faceting options:

If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.

For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.

" + }, + "filterQuery":{ + "shape":"FilterQuery", + "location":"querystring", + "locationName":"fq", + "documentation":"

Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use filterQuery in conjunction with the query parameter to filter the documents that match the constraints specified in the query parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The filterQuery parameter supports the full structured query syntax.

For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.

" + }, + "highlight":{ + "shape":"Highlight", + "location":"querystring", + "locationName":"highlight", + "documentation":"

Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form {\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}.

You can specify the following highlight options:

If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: <em>search-term</em>.

" + }, + "partial":{ + "shape":"Partial", + "location":"querystring", + "locationName":"partial", + "documentation":"

Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.

" + }, + "query":{ + "shape":"Query", + "location":"querystring", + "locationName":"q", + "documentation":"

Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the queryOptions parameter. By default, the simple query parser is used to process requests. To use the structured, lucene, or dismax query parser, you must also specify the queryParser parameter.

For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.

" + }, + "queryOptions":{ + "shape":"QueryOptions", + "location":"querystring", + "locationName":"q.options", + "documentation":"

Configures options for the query parser specified in the queryParser parameter.

The options you can configure vary according to which parser you use:

" + }, + "queryParser":{ + "shape":"QueryParser", + "location":"querystring", + "locationName":"q.parser", + "documentation":"

Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query parser.

Amazon CloudSearch supports four query parsers:

" + }, + "return":{ + "shape":"Return", + "location":"querystring", + "locationName":"return", + "documentation":"

Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (_all_fields). To return only the document IDs for the matching documents, specify _no_fields. To retrieve the relevance score calculated for each document, specify _score.

" + }, + "size":{ + "shape":"Size", + "location":"querystring", + "locationName":"size", + "documentation":"

Specifies the maximum number of search hits to include in the response.

" + }, + "sort":{ + "shape":"Sort", + "location":"querystring", + "locationName":"sort", + "documentation":"

Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (asc or desc) for each field; for example, year desc,title asc. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no sort parameter is specified, results are sorted by their default relevance scores in descending order: _score desc. You can also sort by document ID (_id asc) and version (_version desc).

For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.

" + }, + "start":{ + "shape":"Start", + "location":"querystring", + "locationName":"start", + "documentation":"

Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the start or cursor parameter in a request, they are mutually exclusive.

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

" + } + }, + "documentation":"

Container for the parameters to the Search request.

" + }, + "SearchResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"SearchStatus", + "documentation":"

The status information returned for the search request.

" + }, + "hits":{ + "shape":"Hits", + "documentation":"

The documents that match the search criteria.

" + }, + "facets":{ + "shape":"Facets", + "documentation":"

The requested facet information.

" + } + }, + "documentation":"

The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

" + }, + "SearchStatus":{ + "type":"structure", + "members":{ + "timems":{ + "shape":"Long", + "documentation":"

How long it took to process the request, in milliseconds.

" + }, + "rid":{ + "shape":"String", + "documentation":"

The encrypted resource ID for the request.

" + } + }, + "documentation":"

Contains the resource id (rid) and the time it took to process the request (timems).

" + }, + "Size":{"type":"long"}, + "Sort":{"type":"string"}, + "Start":{"type":"long"}, + "String":{"type":"string"}, + "SuggestModel":{ + "type":"structure", + "members":{ + "query":{ + "shape":"String", + "documentation":"

The query string specified in the suggest request.

" + }, + "found":{ + "shape":"Long", + "documentation":"

The number of documents that were found to match the query string.

" + }, + "suggestions":{ + "shape":"Suggestions", + "documentation":"

The documents that match the query string.

" + } + }, + "documentation":"

Container for the suggestion information returned in a SuggestResponse.

" + }, + "SuggestRequest":{ + "type":"structure", + "required":[ + "query", + "suggester" + ], + "members":{ + "query":{ + "shape":"Query", + "location":"querystring", + "locationName":"q", + "documentation":"

Specifies the string for which you want to get suggestions.

" + }, + "suggester":{ + "shape":"Suggester", + "location":"querystring", + "locationName":"suggester", + "documentation":"

Specifies the name of the suggester to use to find suggested matches.

" + }, + "size":{ + "shape":"SuggestionsSize", + "location":"querystring", + "locationName":"size", + "documentation":"

Specifies the maximum number of suggestions to return.

" + } + }, + "documentation":"

Container for the parameters to the Suggest request.

" + }, + "SuggestResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"SuggestStatus", + "documentation":"

The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems).

" + }, + "suggest":{ + "shape":"SuggestModel", + "documentation":"

Container for the matching search suggestion information.

" + } + }, + "documentation":"

Contains the response to a Suggest request.

" + }, + "SuggestStatus":{ + "type":"structure", + "members":{ + "timems":{ + "shape":"Long", + "documentation":"

How long it took to process the request, in milliseconds.

" + }, + "rid":{ + "shape":"String", + "documentation":"

The encrypted resource ID for the request.

" + } + }, + "documentation":"

Contains the resource id (rid) and the time it took to process the request (timems).

" + }, + "Suggester":{"type":"string"}, + "SuggestionMatch":{ + "type":"structure", + "members":{ + "suggestion":{ + "shape":"String", + "documentation":"

The string that matches the query string specified in the SuggestRequest.

" + }, + "score":{ + "shape":"Long", + "documentation":"

The relevance score of a suggested match.

" + }, + "id":{ + "shape":"String", + "documentation":"

The document ID of the suggested document.

" + } + }, + "documentation":"

An autocomplete suggestion that matches the query string specified in a SuggestRequest.

" + }, + "Suggestions":{ + "type":"list", + "member":{"shape":"SuggestionMatch"} + }, + "SuggestionsSize":{"type":"long"}, + "UploadDocumentsRequest":{ + "type":"structure", + "required":[ + "documents", + "contentType" + ], + "members":{ + "documents":{ + "shape":"Blob", + "documentation":"

A batch of documents formatted in JSON or HTML.

" + }, + "contentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type", + "documentation":"

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

" + } + }, + "documentation":"

Container for the parameters to the UploadDocuments request.

", + "payload":"documents" + }, + "UploadDocumentsResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"String", + "documentation":"

The status of an UploadDocumentsRequest.

" + }, + "adds":{ + "shape":"Adds", + "documentation":"

The number of documents that were added to the search domain.

" + }, + "deletes":{ + "shape":"Deletes", + "documentation":"

The number of documents that were deleted from the search domain.

" + }, + "warnings":{ + "shape":"DocumentServiceWarnings", + "documentation":"

Any warnings returned by the document service about the documents being uploaded.

" + } + }, + "documentation":"

Contains the response to an UploadDocuments request.

" + } + } +} diff --git a/apis/cloudtrail-2013-11-01.api.json b/apis/cloudtrail-2013-11-01.api.json new file mode 100644 index 0000000000..f4c4261988 --- /dev/null +++ b/apis/cloudtrail-2013-11-01.api.json @@ -0,0 +1,183 @@ +{ + "metadata": { + "apiVersion": "2013-11-01", + "endpointPrefix": "cloudtrail", + "jsonVersion": "1.1", + "serviceAbbreviation": "CloudTrail", + "serviceFullName": "AWS CloudTrail", + "signatureVersion": "v4", + "targetPrefix": "com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101", + "protocol": "json" + }, + "operations": { + "CreateTrail": { + "input": { + "type": "structure", + "required": [ + "Name", + "S3BucketName" + ], + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + } + } + } + }, + "DeleteTrail": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeTrails": { + "input": { + "type": "structure", + "members": { + "trailNameList": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "trailList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + } + } + } + } + } + } + }, + "GetTrailStatus": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": { + "IsLogging": { + "type": "boolean" + }, + "LatestDeliveryError": {}, + "LatestNotificationError": {}, + "LatestDeliveryTime": { + "type": "timestamp" + }, + "LatestNotificationTime": { + "type": "timestamp" + }, + "StartLoggingTime": { + "type": "timestamp" + }, + "StopLoggingTime": { + "type": "timestamp" + } + } + } + }, + "StartLogging": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "StopLogging": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateTrail": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "S3BucketName": {}, + "S3KeyPrefix": {}, + "SnsTopicName": {}, + "IncludeGlobalServiceEvents": { + "type": "boolean" + } + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/apis/cloudtrail-2013-11-01.full.json b/apis/cloudtrail-2013-11-01.full.json new file mode 100644 index 0000000000..e968ba6408 --- /dev/null +++ b/apis/cloudtrail-2013-11-01.full.json @@ -0,0 +1,773 @@ +{ + "metadata":{ + "apiVersion":"2013-11-01", + "endpointPrefix":"cloudtrail", + "jsonVersion":"1.1", + "serviceAbbreviation":"CloudTrail", + "serviceFullName":"AWS CloudTrail", + "signatureVersion":"v4", + "targetPrefix":"com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101", + "protocol":"json" + }, + "documentation":"AWS CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.

See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

", + "operations":{ + "CreateTrail":{ + "name":"CreateTrail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateTrailRequest", + "documentation":"

Specifies the settings for each trail.

" + }, + "output":{ + "shape":"CreateTrailResponse", + "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error." + }, + "errors":[ + { + "shape":"MaximumNumberOfTrailsExceededException", + "error":{ + "code":"MaximumNumberOfTrailsExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the maximum number of trails is reached." + }, + { + "shape":"TrailAlreadyExistsException", + "error":{ + "code":"TrailAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the specified trail already exists." + }, + { + "shape":"S3BucketDoesNotExistException", + "error":{ + "code":"S3BucketDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the specified S3 bucket does not exist." + }, + { + "shape":"InsufficientS3BucketPolicyException", + "error":{ + "code":"InsufficientS3BucketPolicy", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the policy on the S3 bucket is not sufficient." + }, + { + "shape":"InsufficientSnsTopicPolicyException", + "error":{ + "code":"InsufficientSnsTopicPolicy", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the policy on the SNS topic is not sufficient." + }, + { + "shape":"InvalidS3BucketNameException", + "error":{ + "code":"InvalidS3BucketName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided S3 bucket name is not valid." + }, + { + "shape":"InvalidS3PrefixException", + "error":{ + "code":"InvalidS3Prefix", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided S3 prefix is not valid." + }, + { + "shape":"InvalidSnsTopicNameException", + "error":{ + "code":"InvalidSnsTopicName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided SNS topic name is not valid." + }, + { + "shape":"InvalidTrailNameException", + "error":{ + "code":"InvalidTrailName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided trail name is not valid." + } + ], + "documentation":"

From the command line, use create-subscription.

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

" + }, + "DeleteTrail":{ + "name":"DeleteTrail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteTrailRequest", + "documentation":"The request that specifies the name of a trail to delete." + }, + "output":{ + "shape":"DeleteTrailResponse", + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "errors":[ + { + "shape":"TrailNotFoundException", + "error":{ + "code":"TrailNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the trail with the given name is not found." + }, + { + "shape":"InvalidTrailNameException", + "error":{ + "code":"InvalidTrailName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided trail name is not valid." + } + ], + "documentation":"

Deletes a trail.

" + }, + "DescribeTrails":{ + "name":"DescribeTrails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeTrailsRequest", + "documentation":"

Returns information about the trail.

" + }, + "output":{ + "shape":"DescribeTrailsResponse", + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "documentation":"

Retrieves settings for the trail associated with the current region for your account.

" + }, + "GetTrailStatus":{ + "name":"GetTrailStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetTrailStatusRequest", + "documentation":"

The name of a trail about which you want the current status.

" + }, + "output":{ + "shape":"GetTrailStatusResponse", + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "errors":[ + { + "shape":"TrailNotFoundException", + "error":{ + "code":"TrailNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the trail with the given name is not found." + }, + { + "shape":"InvalidTrailNameException", + "error":{ + "code":"InvalidTrailName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided trail name is not valid." + } + ], + "documentation":"

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail.

" + }, + "StartLogging":{ + "name":"StartLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"StartLoggingRequest", + "documentation":"

The request to CloudTrail to start logging AWS API calls for an account.

" + }, + "output":{ + "shape":"StartLoggingResponse", + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "errors":[ + { + "shape":"TrailNotFoundException", + "error":{ + "code":"TrailNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the trail with the given name is not found." + }, + { + "shape":"InvalidTrailNameException", + "error":{ + "code":"InvalidTrailName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided trail name is not valid." + } + ], + "documentation":"

Starts the recording of AWS API calls and log file delivery for a trail.

" + }, + "StopLogging":{ + "name":"StopLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"StopLoggingRequest", + "documentation":"

Passes the request to CloudTrail to stop logging AWS API calls for the specified account.

" + }, + "output":{ + "shape":"StopLoggingResponse", + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "errors":[ + { + "shape":"TrailNotFoundException", + "error":{ + "code":"TrailNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the trail with the given name is not found." + }, + { + "shape":"InvalidTrailNameException", + "error":{ + "code":"InvalidTrailName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided trail name is not valid." + } + ], + "documentation":"

Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording.

" + }, + "UpdateTrail":{ + "name":"UpdateTrail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateTrailRequest", + "documentation":"

Specifies settings to update for the trail.

" + }, + "output":{ + "shape":"UpdateTrailResponse", + "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error." + }, + "errors":[ + { + "shape":"S3BucketDoesNotExistException", + "error":{ + "code":"S3BucketDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the specified S3 bucket does not exist." + }, + { + "shape":"InsufficientS3BucketPolicyException", + "error":{ + "code":"InsufficientS3BucketPolicy", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the policy on the S3 bucket is not sufficient." + }, + { + "shape":"InsufficientSnsTopicPolicyException", + "error":{ + "code":"InsufficientSnsTopicPolicy", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the policy on the SNS topic is not sufficient." + }, + { + "shape":"TrailNotFoundException", + "error":{ + "code":"TrailNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the trail with the given name is not found." + }, + { + "shape":"InvalidS3BucketNameException", + "error":{ + "code":"InvalidS3BucketName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided S3 bucket name is not valid." + }, + { + "shape":"InvalidS3PrefixException", + "error":{ + "code":"InvalidS3Prefix", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided S3 prefix is not valid." + }, + { + "shape":"InvalidSnsTopicNameException", + "error":{ + "code":"InvalidSnsTopicName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided SNS topic name is not valid." + }, + { + "shape":"InvalidTrailNameException", + "error":{ + "code":"InvalidTrailName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided trail name is not valid." + } + ], + "documentation":"

From the command line, use update-subscription.

Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket.

" + } + }, + "shapes":{ + "Boolean":{"type":"boolean"}, + "CreateTrailRequest":{ + "type":"structure", + "required":[ + "Name", + "S3BucketName" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name of the trail.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + } + }, + "documentation":"

Specifies the settings for each trail.

" + }, + "CreateTrailResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name of the trail.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + } + }, + "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error." + }, + "Date":{"type":"timestamp"}, + "DeleteTrailRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of a trail to be deleted.

" + } + }, + "documentation":"The request that specifies the name of a trail to delete." + }, + "DeleteTrailResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "DescribeTrailsRequest":{ + "type":"structure", + "members":{ + "trailNameList":{ + "shape":"TrailNameList", + "documentation":"

The trail returned.

" + } + }, + "documentation":"

Returns information about the trail.

" + }, + "DescribeTrailsResponse":{ + "type":"structure", + "members":{ + "trailList":{ + "shape":"TrailList", + "documentation":"

The list of trails.

" + } + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "GetTrailStatusRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the trail for which you are requesting the current status.

" + } + }, + "documentation":"

The name of a trail about which you want the current status.

" + }, + "GetTrailStatusResponse":{ + "type":"structure", + "members":{ + "IsLogging":{ + "shape":"Boolean", + "documentation":"

Whether the CloudTrail is currently logging AWS API calls.

" + }, + "LatestDeliveryError":{ + "shape":"String", + "documentation":"

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.

" + }, + "LatestNotificationError":{ + "shape":"String", + "documentation":"

Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.

" + }, + "LatestDeliveryTime":{ + "shape":"Date", + "documentation":"

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

" + }, + "LatestNotificationTime":{ + "shape":"Date", + "documentation":"

Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

" + }, + "StartLoggingTime":{ + "shape":"Date", + "documentation":"

Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.

" + }, + "StopLoggingTime":{ + "shape":"Date", + "documentation":"

Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.

" + } + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "InsufficientS3BucketPolicyException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientS3BucketPolicy", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the policy on the S3 bucket is not sufficient." + }, + "InsufficientSnsTopicPolicyException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientSnsTopicPolicy", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the policy on the SNS topic is not sufficient." + }, + "InvalidS3BucketNameException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidS3BucketName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided S3 bucket name is not valid." + }, + "InvalidS3PrefixException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidS3Prefix", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided S3 prefix is not valid." + }, + "InvalidSnsTopicNameException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSnsTopicName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided SNS topic name is not valid." + }, + "InvalidTrailNameException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidTrailName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the provided trail name is not valid." + }, + "MaximumNumberOfTrailsExceededException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"MaximumNumberOfTrailsExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the maximum number of trails is reached." + }, + "S3BucketDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"S3BucketDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the specified S3 bucket does not exist." + }, + "StartLoggingRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the trail for which CloudTrail logs AWS API calls.

" + } + }, + "documentation":"

The request to CloudTrail to start logging AWS API calls for an account.

" + }, + "StartLoggingResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "StopLoggingRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Communicates to CloudTrail the name of the trail for which to stop logging AWS API calls.

" + } + }, + "documentation":"

Passes the request to CloudTrail to stop logging AWS API calls for the specified account.

" + }, + "StopLoggingResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "String":{"type":"string"}, + "Trail":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Name of the trail set by calling CreateTrail.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Value of the Amazon S3 prefix.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

" + } + }, + "documentation":"

The settings for a trail.

" + }, + "TrailAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TrailAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the specified trail already exists." + }, + "TrailList":{ + "type":"list", + "member":{"shape":"Trail"} + }, + "TrailNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "TrailNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TrailNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"This exception is thrown when the trail with the given name is not found." + }, + "UpdateTrailRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name of the trail.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + } + }, + "documentation":"

Specifies settings to update for the trail.

" + }, + "UpdateTrailResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name of the trail.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + } + }, + "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error." + } + } +} diff --git a/apis/cloudtrail-2013-11-01.paginators.json b/apis/cloudtrail-2013-11-01.paginators.json new file mode 100644 index 0000000000..a11f43616b --- /dev/null +++ b/apis/cloudtrail-2013-11-01.paginators.json @@ -0,0 +1,7 @@ +{ + "pagination": { + "DescribeTrails": { + "result_key": "trailList" + } + } +} diff --git a/apis/cognito-identity-2014-06-30.api.json b/apis/cognito-identity-2014-06-30.api.json new file mode 100644 index 0000000000..bd604d9fad --- /dev/null +++ b/apis/cognito-identity-2014-06-30.api.json @@ -0,0 +1,324 @@ +{ + "metadata": { + "apiVersion": "2014-06-30", + "endpointPrefix": "cognito-identity", + "jsonVersion": "1.1", + "serviceFullName": "Amazon Cognito Identity", + "signatureVersion": "v4", + "targetPrefix": "AWSCognitoIdentityService", + "protocol": "json" + }, + "operations": { + "CreateIdentityPool": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolName", + "AllowUnauthenticatedIdentities" + ], + "members": { + "IdentityPoolName": {}, + "AllowUnauthenticatedIdentities": { + "type": "boolean" + }, + "SupportedLoginProviders": { + "shape": "S4" + }, + "DeveloperProviderName": {} + } + }, + "output": { + "shape": "S8" + } + }, + "DeleteIdentityPool": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": {} + } + } + }, + "DescribeIdentityPool": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": {} + } + }, + "output": { + "shape": "S8" + } + }, + "GetId": { + "input": { + "type": "structure", + "required": [ + "AccountId", + "IdentityPoolId" + ], + "members": { + "AccountId": {}, + "IdentityPoolId": {}, + "Logins": { + "shape": "Se" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {} + } + } + }, + "GetOpenIdToken": { + "input": { + "type": "structure", + "required": [ + "IdentityId" + ], + "members": { + "IdentityId": {}, + "Logins": { + "shape": "Se" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {}, + "Token": {} + } + } + }, + "GetOpenIdTokenForDeveloperIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "Logins" + ], + "members": { + "IdentityPoolId": {}, + "IdentityId": {}, + "Logins": { + "shape": "Se" + }, + "TokenDuration": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {}, + "Token": {} + } + } + }, + "ListIdentities": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "MaxResults" + ], + "members": { + "IdentityPoolId": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "Identities": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IdentityId": {}, + "Logins": { + "shape": "Su" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListIdentityPools": { + "input": { + "type": "structure", + "required": [ + "MaxResults" + ], + "members": { + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPools": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "IdentityPoolName": {} + } + } + }, + "NextToken": {} + } + } + }, + "LookupDeveloperIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": {}, + "IdentityId": {}, + "DeveloperUserIdentifier": {}, + "MaxResults": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {}, + "DeveloperUserIdentifierList": { + "type": "list", + "member": {} + }, + "NextToken": {} + } + } + }, + "MergeDeveloperIdentities": { + "input": { + "type": "structure", + "required": [ + "SourceUserIdentifier", + "DestinationUserIdentifier", + "DeveloperProviderName", + "IdentityPoolId" + ], + "members": { + "SourceUserIdentifier": {}, + "DestinationUserIdentifier": {}, + "DeveloperProviderName": {}, + "IdentityPoolId": {} + } + }, + "output": { + "type": "structure", + "members": { + "IdentityId": {} + } + } + }, + "UnlinkDeveloperIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityId", + "IdentityPoolId", + "DeveloperProviderName", + "DeveloperUserIdentifier" + ], + "members": { + "IdentityId": {}, + "IdentityPoolId": {}, + "DeveloperProviderName": {}, + "DeveloperUserIdentifier": {} + } + } + }, + "UnlinkIdentity": { + "input": { + "type": "structure", + "required": [ + "IdentityId", + "Logins", + "LoginsToRemove" + ], + "members": { + "IdentityId": {}, + "Logins": { + "shape": "Se" + }, + "LoginsToRemove": { + "shape": "Su" + } + } + } + }, + "UpdateIdentityPool": { + "input": { + "shape": "S8" + }, + "output": { + "shape": "S8" + } + } + }, + "shapes": { + "S4": { + "type": "map", + "key": {}, + "value": {} + }, + "S8": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityPoolName", + "AllowUnauthenticatedIdentities" + ], + "members": { + "IdentityPoolId": {}, + "IdentityPoolName": {}, + "AllowUnauthenticatedIdentities": { + "type": "boolean" + }, + "SupportedLoginProviders": { + "shape": "S4" + }, + "DeveloperProviderName": {} + } + }, + "Se": { + "type": "map", + "key": {}, + "value": {} + }, + "Su": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/apis/cognito-identity-2014-06-30.full.json b/apis/cognito-identity-2014-06-30.full.json new file mode 100644 index 0000000000..0535110276 --- /dev/null +++ b/apis/cognito-identity-2014-06-30.full.json @@ -0,0 +1,1289 @@ +{ + "metadata":{ + "apiVersion":"2014-06-30", + "endpointPrefix":"cognito-identity", + "jsonVersion":"1.1", + "serviceFullName":"Amazon Cognito Identity", + "signatureVersion":"v4", + "targetPrefix":"AWSCognitoIdentityService", + "protocol":"json" + }, + "documentation":"Amazon Cognito

Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.

Next, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.

", + "operations":{ + "CreateIdentityPool":{ + "name":"CreateIdentityPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateIdentityPoolInput", + "documentation":"

Input to the CreateIdentityPool action.

" + }, + "output":{ + "shape":"IdentityPool", + "documentation":"An object representing a Cognito identity pool." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown when the total number of user pools has exceeded a preset limit." + } + ], + "documentation":"

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account.

" + }, + "DeleteIdentityPool":{ + "name":"DeleteIdentityPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteIdentityPoolInput", + "documentation":"

Input to the DeleteIdentityPool action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.

" + }, + "DescribeIdentityPool":{ + "name":"DescribeIdentityPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeIdentityPoolInput", + "documentation":"Input to the DescribeIdentityPool action." + }, + "output":{ + "shape":"IdentityPool", + "documentation":"An object representing a Cognito identity pool." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

" + }, + "GetId":{ + "name":"GetId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetIdInput", + "documentation":"Input to the GetId action." + }, + "output":{ + "shape":"GetIdResponse", + "documentation":"Returned in response to a GetId request." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown when the total number of user pools has exceeded a preset limit." + } + ], + "documentation":"

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

" + }, + "GetOpenIdToken":{ + "name":"GetOpenIdToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetOpenIdTokenInput", + "documentation":"Input to the GetOpenIdToken action." + }, + "output":{ + "shape":"GetOpenIdTokenResponse", + "documentation":"Returned in response to a successful GetOpenIdToken request." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 15 minutes.

" + }, + "GetOpenIdTokenForDeveloperIdentity":{ + "name":"GetOpenIdTokenForDeveloperIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetOpenIdTokenForDeveloperIdentityInput", + "documentation":"

Input to the GetOpenIdTokenForDeveloperIdentity action.

" + }, + "output":{ + "shape":"GetOpenIdTokenForDeveloperIdentityResponse", + "documentation":"

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + }, + { + "shape":"DeveloperUserAlreadyRegisteredException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The provided developer user identifier is already registered with Cognito under a different identity ID.

" + } + ], + "documentation":"

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the \"domain\" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.

" + }, + "ListIdentities":{ + "name":"ListIdentities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListIdentitiesInput", + "documentation":"Input to the ListIdentities action." + }, + "output":{ + "shape":"ListIdentitiesResponse", + "documentation":"The response to a ListIdentities request." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Lists the identities in a pool.

" + }, + "ListIdentityPools":{ + "name":"ListIdentityPools", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListIdentityPoolsInput", + "documentation":"Input to the ListIdentityPools action." + }, + "output":{ + "shape":"ListIdentityPoolsResponse", + "documentation":"The result of a successful ListIdentityPools action." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Lists all of the Cognito identity pools registered for your account.

" + }, + "LookupDeveloperIdentity":{ + "name":"LookupDeveloperIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"LookupDeveloperIdentityInput", + "documentation":"

Input to the LookupDeveloperIdentityInput action.

" + }, + "output":{ + "shape":"LookupDeveloperIdentityResponse", + "documentation":"

Returned in response to a successful LookupDeveloperIdentity action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

" + }, + "MergeDeveloperIdentities":{ + "name":"MergeDeveloperIdentities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"MergeDeveloperIdentitiesInput", + "documentation":"

Input to the MergeDeveloperIdentities action.

" + }, + "output":{ + "shape":"MergeDeveloperIdentitiesResponse", + "documentation":"

Returned in response to a successful MergeDeveloperIdentities action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

" + }, + "UnlinkDeveloperIdentity":{ + "name":"UnlinkDeveloperIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UnlinkDeveloperIdentityInput", + "documentation":"

Input to the UnlinkDeveloperIdentity action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

" + }, + "UnlinkIdentity":{ + "name":"UnlinkIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UnlinkIdentityInput", + "documentation":"Input to the UnlinkIdentity action." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

" + }, + "UpdateIdentityPool":{ + "name":"UpdateIdentityPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"IdentityPool", + "documentation":"An object representing a Cognito identity pool." + }, + "output":{ + "shape":"IdentityPool", + "documentation":"An object representing a Cognito identity pool." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + { + "shape":"NotAuthorizedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceConflictException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + { + "shape":"TooManyRequestsException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + { + "shape":"InternalErrorException", + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + } + ], + "documentation":"

Updates a user pool.

" + } + }, + "shapes":{ + "AccountId":{ + "type":"string", + "min":1, + "max":15, + "pattern":"\\d+" + }, + "CreateIdentityPoolInput":{ + "type":"structure", + "required":[ + "IdentityPoolName", + "AllowUnauthenticatedIdentities" + ], + "members":{ + "IdentityPoolName":{ + "shape":"IdentityPoolName", + "documentation":"

A string that you provide.

" + }, + "AllowUnauthenticatedIdentities":{ + "shape":"IdentityPoolUnauthenticated", + "documentation":"

TRUE if the identity pool supports unauthenticated logins.

" + }, + "SupportedLoginProviders":{ + "shape":"IdentityProviders", + "documentation":"

Optional key:value pairs mapping provider names to provider app IDs.

" + }, + "DeveloperProviderName":{ + "shape":"DeveloperProviderName", + "documentation":"

The \"domain\" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

" + } + }, + "documentation":"

Input to the CreateIdentityPool action.

" + }, + "DeleteIdentityPoolInput":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"An identity pool ID in the format REGION:GUID." + } + }, + "documentation":"

Input to the DeleteIdentityPool action.

" + }, + "DescribeIdentityPoolInput":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"An identity pool ID in the format REGION:GUID." + } + }, + "documentation":"Input to the DescribeIdentityPool action." + }, + "DeveloperProviderName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w._-]+" + }, + "DeveloperUserAlreadyRegisteredException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

This developer user identifier is already registered with Cognito.

" + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The provided developer user identifier is already registered with Cognito under a different identity ID.

" + }, + "DeveloperUserIdentifier":{"type":"string"}, + "DeveloperUserIdentifierList":{ + "type":"list", + "member":{"shape":"DeveloperUserIdentifier"} + }, + "GetIdInput":{ + "type":"structure", + "required":[ + "AccountId", + "IdentityPoolId" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"A standard AWS account ID (9+ digits)." + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"An identity pool ID in the format REGION:GUID." + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"

A set of optional name-value pairs that map provider names to provider tokens.

The available provider names for Logins are as follows:

" + } + }, + "documentation":"Input to the GetId action." + }, + "GetIdResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A unique identifier in the format REGION:GUID." + } + }, + "documentation":"Returned in response to a GetId request." + }, + "GetOpenIdTokenForDeveloperIdentityInput":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "Logins" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax \"developer_provider_name\": \"developer_user_identifier\". The developer provider is the \"domain\" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

" + }, + "TokenDuration":{ + "shape":"TokenDuration", + "documentation":"

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

" + } + }, + "documentation":"

Input to the GetOpenIdTokenForDeveloperIdentity action.

" + }, + "GetOpenIdTokenForDeveloperIdentityResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Token":{ + "shape":"OIDCToken", + "documentation":"

An OpenID token.

" + } + }, + "documentation":"

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

" + }, + "GetOpenIdTokenInput":{ + "type":"structure", + "required":["IdentityId"], + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A unique identifier in the format REGION:GUID." + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"A set of optional name-value pairs that map provider names to provider tokens." + } + }, + "documentation":"Input to the GetOpenIdToken action." + }, + "GetOpenIdTokenResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input." + }, + "Token":{ + "shape":"OIDCToken", + "documentation":"An OpenID token, valid for 15 minutes." + } + }, + "documentation":"Returned in response to a successful GetOpenIdToken request." + }, + "IdentitiesList":{ + "type":"list", + "member":{"shape":"IdentityDescription"} + }, + "IdentityDescription":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A unique identifier in the format REGION:GUID." + }, + "Logins":{ + "shape":"LoginsList", + "documentation":"A set of optional name-value pairs that map provider names to provider tokens." + } + }, + "documentation":"A description of the identity." + }, + "IdentityId":{ + "type":"string", + "min":1, + "max":50, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "IdentityPool":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityPoolName", + "AllowUnauthenticatedIdentities" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"An identity pool ID in the format REGION:GUID." + }, + "IdentityPoolName":{ + "shape":"IdentityPoolName", + "documentation":"

A string that you provide.

" + }, + "AllowUnauthenticatedIdentities":{ + "shape":"IdentityPoolUnauthenticated", + "documentation":"TRUE if the identity pool supports unauthenticated logins." + }, + "SupportedLoginProviders":{ + "shape":"IdentityProviders", + "documentation":"

Optional key:value pairs mapping provider names to provider app IDs.

" + }, + "DeveloperProviderName":{ + "shape":"DeveloperProviderName", + "documentation":"

The \"domain\" by which Cognito will refer to your users.

" + } + }, + "documentation":"An object representing a Cognito identity pool." + }, + "IdentityPoolId":{ + "type":"string", + "min":1, + "max":50, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "IdentityPoolName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w ]+" + }, + "IdentityPoolShortDescription":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"An identity pool ID in the format REGION:GUID." + }, + "IdentityPoolName":{ + "shape":"IdentityPoolName", + "documentation":"A string that you provide." + } + }, + "documentation":"A description of the identity pool." + }, + "IdentityPoolUnauthenticated":{"type":"boolean"}, + "IdentityPoolsList":{ + "type":"list", + "member":{"shape":"IdentityPoolShortDescription"} + }, + "IdentityProviderId":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w._-]+" + }, + "IdentityProviderName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w._-]+" + }, + "IdentityProviderToken":{ + "type":"string", + "min":1, + "max":1024, + "pattern":"[\\S]+" + }, + "IdentityProviders":{ + "type":"map", + "key":{"shape":"IdentityProviderName"}, + "value":{"shape":"IdentityProviderId"}, + "max":10 + }, + "InternalErrorException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"The message returned by an InternalErrorException." + } + }, + "exception":true, + "fault":true, + "documentation":"Thrown when the service encounters an error during processing the request." + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"The message returned by an InvalidParameterException." + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown for missing or bad input parameter(s)." + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"The message returned by a LimitExceededException." + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Thrown when the total number of user pools has exceeded a preset limit." + }, + "ListIdentitiesInput":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "MaxResults" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"An identity pool ID in the format REGION:GUID." + }, + "MaxResults":{ + "shape":"QueryLimit", + "documentation":"The maximum number of identities to return." + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"A pagination token." + } + }, + "documentation":"Input to the ListIdentities action." + }, + "ListIdentitiesResponse":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"An identity pool ID in the format REGION:GUID." + }, + "Identities":{ + "shape":"IdentitiesList", + "documentation":"An object containing a set of identities and associated mappings." + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"A pagination token." + } + }, + "documentation":"The response to a ListIdentities request." + }, + "ListIdentityPoolsInput":{ + "type":"structure", + "required":["MaxResults"], + "members":{ + "MaxResults":{ + "shape":"QueryLimit", + "documentation":"The maximum number of identities to return." + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"A pagination token." + } + }, + "documentation":"Input to the ListIdentityPools action." + }, + "ListIdentityPoolsResponse":{ + "type":"structure", + "members":{ + "IdentityPools":{ + "shape":"IdentityPoolsList", + "documentation":"The identity pools returned by the ListIdentityPools action." + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"A pagination token." + } + }, + "documentation":"The result of a successful ListIdentityPools action." + }, + "LoginsList":{ + "type":"list", + "member":{"shape":"IdentityProviderName"} + }, + "LoginsMap":{ + "type":"map", + "key":{"shape":"IdentityProviderName"}, + "value":{"shape":"IdentityProviderToken"}, + "max":10 + }, + "LookupDeveloperIdentityInput":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "DeveloperUserIdentifier":{ + "shape":"DeveloperUserIdentifier", + "documentation":"

A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

" + }, + "MaxResults":{ + "shape":"QueryLimit", + "documentation":"

The maximum number of identities to return.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

" + } + }, + "documentation":"

Input to the LookupDeveloperIdentityInput action.

" + }, + "LookupDeveloperIdentityResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "DeveloperUserIdentifierList":{ + "shape":"DeveloperUserIdentifierList", + "documentation":"

This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

" + } + }, + "documentation":"

Returned in response to a successful LookupDeveloperIdentity action.

" + }, + "MergeDeveloperIdentitiesInput":{ + "type":"structure", + "required":[ + "SourceUserIdentifier", + "DestinationUserIdentifier", + "DeveloperProviderName", + "IdentityPoolId" + ], + "members":{ + "SourceUserIdentifier":{ + "shape":"DeveloperUserIdentifier", + "documentation":"

User identifier for the source user. The value should be a DeveloperUserIdentifier.

" + }, + "DestinationUserIdentifier":{ + "shape":"DeveloperUserIdentifier", + "documentation":"

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

" + }, + "DeveloperProviderName":{ + "shape":"DeveloperProviderName", + "documentation":"

The \"domain\" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

" + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + } + }, + "documentation":"

Input to the MergeDeveloperIdentities action.

" + }, + "MergeDeveloperIdentitiesResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + } + }, + "documentation":"

Returned in response to a successful MergeDeveloperIdentities action.

" + }, + "NotAuthorizedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"The message returned by a NotAuthorizedException" + } + }, + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + "OIDCToken":{"type":"string"}, + "PaginationKey":{ + "type":"string", + "min":1 + }, + "QueryLimit":{ + "type":"integer", + "min":1, + "max":60 + }, + "ResourceConflictException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"The message returned by a ResourceConflictException." + } + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"Thrown when a user tries to use a login which is already linked to another account." + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"The message returned by a ResourceNotFoundException." + } + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." + }, + "String":{"type":"string"}, + "TokenDuration":{ + "type":"long", + "min":1, + "max":86400 + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"Message returned by a TooManyRequestsException" + } + }, + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"Thrown when a request is throttled." + }, + "UnlinkDeveloperIdentityInput":{ + "type":"structure", + "required":[ + "IdentityId", + "IdentityPoolId", + "DeveloperProviderName", + "DeveloperUserIdentifier" + ], + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "DeveloperProviderName":{ + "shape":"DeveloperProviderName", + "documentation":"

The \"domain\" by which Cognito will refer to your users.

" + }, + "DeveloperUserIdentifier":{ + "shape":"DeveloperUserIdentifier", + "documentation":"A unique ID used by your backend authentication process to identify a user." + } + }, + "documentation":"

Input to the UnlinkDeveloperIdentity action.

" + }, + "UnlinkIdentityInput":{ + "type":"structure", + "required":[ + "IdentityId", + "Logins", + "LoginsToRemove" + ], + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A unique identifier in the format REGION:GUID." + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"A set of optional name-value pairs that map provider names to provider tokens." + }, + "LoginsToRemove":{ + "shape":"LoginsList", + "documentation":"Provider names to unlink from this identity." + } + }, + "documentation":"Input to the UnlinkIdentity action." + } + } +} diff --git a/apis/cognito-sync-2014-06-30.api.json b/apis/cognito-sync-2014-06-30.api.json new file mode 100644 index 0000000000..89a6c77309 --- /dev/null +++ b/apis/cognito-sync-2014-06-30.api.json @@ -0,0 +1,440 @@ +{ + "metadata": { + "apiVersion": "2014-06-30", + "endpointPrefix": "cognito-sync", + "jsonVersion": "1.1", + "serviceFullName": "Amazon Cognito Sync", + "signatureVersion": "v4", + "protocol": "rest-json" + }, + "operations": { + "DeleteDataset": { + "http": { + "method": "DELETE", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Dataset": { + "shape": "S6" + } + } + } + }, + "DescribeDataset": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + } + } + }, + "output": { + "type": "structure", + "members": { + "Dataset": { + "shape": "S6" + } + } + } + }, + "DescribeIdentityPoolUsage": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolUsage": { + "shape": "Se" + } + } + } + }, + "DescribeIdentityUsage": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityUsage": { + "type": "structure", + "members": { + "IdentityId": {}, + "IdentityPoolId": {}, + "LastModifiedDate": { + "type": "timestamp" + }, + "DatasetCount": { + "type": "integer" + }, + "DataStorage": { + "type": "long" + } + } + } + } + } + }, + "ListDatasets": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityId", + "IdentityPoolId" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Datasets": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "Count": { + "type": "integer" + }, + "NextToken": {} + } + } + }, + "ListIdentityPoolUsage": { + "http": { + "method": "GET", + "requestUri": "/identitypools", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "IdentityPoolUsages": { + "type": "list", + "member": { + "shape": "Se" + } + }, + "MaxResults": { + "type": "integer" + }, + "Count": { + "type": "integer" + }, + "NextToken": {} + } + } + }, + "ListRecords": { + "http": { + "method": "GET", + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + }, + "LastSyncCount": { + "location": "querystring", + "locationName": "lastSyncCount", + "type": "long" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "SyncSessionToken": { + "location": "querystring", + "locationName": "syncSessionToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Records": { + "shape": "St" + }, + "NextToken": {}, + "Count": { + "type": "integer" + }, + "DatasetSyncCount": { + "type": "long" + }, + "LastModifiedBy": {}, + "MergedDatasetNames": { + "type": "list", + "member": {} + }, + "DatasetExists": { + "type": "boolean" + }, + "DatasetDeletedAfterRequestedSyncCount": { + "type": "boolean" + }, + "SyncSessionToken": {} + } + } + }, + "UpdateRecords": { + "http": { + "requestUri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "IdentityPoolId", + "IdentityId", + "DatasetName", + "SyncSessionToken" + ], + "members": { + "IdentityPoolId": { + "location": "uri", + "locationName": "IdentityPoolId" + }, + "IdentityId": { + "location": "uri", + "locationName": "IdentityId" + }, + "DatasetName": { + "location": "uri", + "locationName": "DatasetName" + }, + "RecordPatches": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Op", + "Key", + "SyncCount" + ], + "members": { + "Op": {}, + "Key": {}, + "Value": {}, + "SyncCount": { + "type": "long" + }, + "DeviceLastModifiedDate": { + "type": "timestamp" + } + } + } + }, + "SyncSessionToken": {}, + "ClientContext": { + "location": "header", + "locationName": "x-amz-Client-Context" + } + } + }, + "output": { + "type": "structure", + "members": { + "Records": { + "shape": "St" + } + } + } + } + }, + "shapes": { + "S6": { + "type": "structure", + "members": { + "IdentityId": {}, + "DatasetName": {}, + "CreationDate": { + "type": "timestamp" + }, + "LastModifiedDate": { + "type": "timestamp" + }, + "LastModifiedBy": {}, + "DataStorage": { + "type": "long" + }, + "NumRecords": { + "type": "long" + } + } + }, + "Se": { + "type": "structure", + "members": { + "IdentityPoolId": {}, + "SyncSessionsCount": { + "type": "long" + }, + "DataStorage": { + "type": "long" + }, + "LastModifiedDate": { + "type": "timestamp" + } + } + }, + "St": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {}, + "SyncCount": { + "type": "long" + }, + "LastModifiedDate": { + "type": "timestamp" + }, + "LastModifiedBy": {}, + "DeviceLastModifiedDate": { + "type": "timestamp" + } + } + } + } + } +} \ No newline at end of file diff --git a/apis/cognito-sync-2014-06-30.full.json b/apis/cognito-sync-2014-06-30.full.json new file mode 100644 index 0000000000..19b34b0f31 --- /dev/null +++ b/apis/cognito-sync-2014-06-30.full.json @@ -0,0 +1,1196 @@ +{ + "metadata":{ + "apiVersion":"2014-06-30", + "endpointPrefix":"cognito-sync", + "jsonVersion":"1.1", + "serviceFullName":"Amazon Cognito Sync", + "signatureVersion":"v4", + "protocol":"rest-json" + }, + "documentation":"Amazon Cognito Sync

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.

With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.

", + "operations":{ + "DeleteDataset":{ + "name":"DeleteDataset", + "http":{ + "method":"DELETE", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode":200 + }, + "input":{ + "shape":"DeleteDatasetRequest", + "documentation":"A request to delete the specific dataset." + }, + "output":{ + "shape":"DeleteDatasetResponse", + "documentation":"Response to a successful DeleteDataset request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any consequent operation on this dataset will result in a ResourceNotFoundException." + }, + "DescribeDataset":{ + "name":"DescribeDataset", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode":200 + }, + "input":{ + "shape":"DescribeDatasetRequest", + "documentation":"A request for metadata about a dataset (creation date, number of records, size) by owner and dataset name." + }, + "output":{ + "shape":"DescribeDatasetResponse", + "documentation":"Response to a successful DescribeDataset request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"Gets metadata about a dataset by identity and dataset name. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call." + }, + "DescribeIdentityPoolUsage":{ + "name":"DescribeIdentityPoolUsage", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}", + "responseCode":200 + }, + "input":{ + "shape":"DescribeIdentityPoolUsageRequest", + "documentation":"A request for usage information about the identity pool." + }, + "output":{ + "shape":"DescribeIdentityPoolUsageResponse", + "documentation":"Response to a successful DescribeIdentityPoolUsage request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"Gets usage details (for example, data storage) about a particular identity pool." + }, + "DescribeIdentityUsage":{ + "name":"DescribeIdentityUsage", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}", + "responseCode":200 + }, + "input":{ + "shape":"DescribeIdentityUsageRequest", + "documentation":"A request for information about the usage of an identity pool." + }, + "output":{ + "shape":"DescribeIdentityUsageResponse", + "documentation":"The response to a successful DescribeIdentityUsage request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"Gets usage information for an identity, including number of datasets and data usage." + }, + "ListDatasets":{ + "name":"ListDatasets", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets", + "responseCode":200 + }, + "input":{ + "shape":"ListDatasetsRequest", + "documentation":"Request for a list of datasets for an identity." + }, + "output":{ + "shape":"ListDatasetsResponse", + "documentation":"Returned for a successful ListDatasets request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"Lists datasets for an identity. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call." + }, + "ListIdentityPoolUsage":{ + "name":"ListIdentityPoolUsage", + "http":{ + "method":"GET", + "requestUri":"/identitypools", + "responseCode":200 + }, + "input":{ + "shape":"ListIdentityPoolUsageRequest", + "documentation":"A request for usage information on an identity pool." + }, + "output":{ + "shape":"ListIdentityPoolUsageResponse", + "documentation":"Returned for a successful ListIdentityPoolUsage request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"Gets a list of identity pools registered with Cognito." + }, + "ListRecords":{ + "name":"ListRecords", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records", + "responseCode":200 + }, + "input":{ + "shape":"ListRecordsRequest", + "documentation":"A request for a list of records." + }, + "output":{ + "shape":"ListRecordsResponse", + "documentation":"Returned for a successful ListRecordsRequest." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"Gets paginated records, optionally changed after a particular sync count for a dataset and identity. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call." + }, + "UpdateRecords":{ + "name":"UpdateRecords", + "http":{ + "method":"POST", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode":200 + }, + "input":{ + "shape":"UpdateRecordsRequest", + "documentation":"A request to post updates to records or add and delete records for a dataset and user." + }, + "output":{ + "shape":"UpdateRecordsResponse", + "documentation":"Returned for a successful UpdateRecordsRequest." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." + }, + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"ResourceConflictException", + "error":{ + "code":"ResourceConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"Posts updates to records and add and delete records for a dataset and user. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call." + } + }, + "shapes":{ + "Boolean":{"type":"boolean"}, + "ClientContext":{"type":"string"}, + "Dataset":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "CreationDate":{ + "shape":"Date", + "documentation":"Date on which the dataset was created." + }, + "LastModifiedDate":{ + "shape":"Date", + "documentation":"Date when the dataset was last modified." + }, + "LastModifiedBy":{ + "shape":"String", + "documentation":"The device that made the last change to this dataset." + }, + "DataStorage":{ + "shape":"Long", + "documentation":"Total size in bytes of the records in this dataset." + }, + "NumRecords":{ + "shape":"Long", + "documentation":"Number of records in this dataset." + } + }, + "documentation":"A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." + }, + "DatasetList":{ + "type":"list", + "member":{"shape":"Dataset"} + }, + "DatasetName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[a-zA-Z0-9_.:-]+" + }, + "Date":{"type":"timestamp"}, + "DeleteDatasetRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + } + }, + "documentation":"A request to delete the specific dataset." + }, + "DeleteDatasetResponse":{ + "type":"structure", + "members":{ + "Dataset":{ + "shape":"Dataset", + "documentation":"A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." + } + }, + "documentation":"Response to a successful DeleteDataset request." + }, + "DescribeDatasetRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + } + }, + "documentation":"A request for metadata about a dataset (creation date, number of records, size) by owner and dataset name." + }, + "DescribeDatasetResponse":{ + "type":"structure", + "members":{ + "Dataset":{ + "shape":"Dataset", + "documentation":"Metadata for a collection of data for an identity. An identity can have multiple datasets. A dataset can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." + } + }, + "documentation":"Response to a successful DescribeDataset request." + }, + "DescribeIdentityPoolUsageRequest":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + } + }, + "documentation":"A request for usage information about the identity pool." + }, + "DescribeIdentityPoolUsageResponse":{ + "type":"structure", + "members":{ + "IdentityPoolUsage":{ + "shape":"IdentityPoolUsage", + "documentation":"Information about the usage of the identity pool." + } + }, + "documentation":"Response to a successful DescribeIdentityPoolUsage request." + }, + "DescribeIdentityUsageRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + } + }, + "documentation":"A request for information about the usage of an identity pool." + }, + "DescribeIdentityUsageResponse":{ + "type":"structure", + "members":{ + "IdentityUsage":{ + "shape":"IdentityUsage", + "documentation":"Usage information for the identity." + } + }, + "documentation":"The response to a successful DescribeIdentityUsage request." + }, + "ExceptionMessage":{"type":"string"}, + "IdentityId":{ + "type":"string", + "min":1, + "max":50, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "IdentityPoolId":{ + "type":"string", + "min":1, + "max":50, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "IdentityPoolUsage":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "SyncSessionsCount":{ + "shape":"Long", + "documentation":"Number of sync sessions for the identity pool." + }, + "DataStorage":{ + "shape":"Long", + "documentation":"Data storage information for the identity pool." + }, + "LastModifiedDate":{ + "shape":"Date", + "documentation":"Date on which the identity pool was last modified." + } + }, + "documentation":"Usage information for the identity pool." + }, + "IdentityPoolUsageList":{ + "type":"list", + "member":{"shape":"IdentityPoolUsage"} + }, + "IdentityUsage":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "LastModifiedDate":{ + "shape":"Date", + "documentation":"Date on which the identity was last modified." + }, + "DatasetCount":{ + "shape":"Integer", + "documentation":"Number of datasets for the identity." + }, + "DataStorage":{ + "shape":"Long", + "documentation":"Total data storage for this identity." + } + }, + "documentation":"Usage information for the identity." + }, + "Integer":{"type":"integer"}, + "IntegerString":{"type":"integer"}, + "InternalErrorException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by InternalErrorException." + } + }, + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + "InvalidParameterException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by InvalidParameterException." + } + }, + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + "LimitExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by LimitExceededException." + } + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." + }, + "ListDatasetsRequest":{ + "type":"structure", + "required":[ + "IdentityId", + "IdentityPoolId" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"nextToken", + "documentation":"A pagination token for obtaining the next page of results." + }, + "MaxResults":{ + "shape":"IntegerString", + "location":"querystring", + "locationName":"maxResults", + "documentation":"The maximum number of results to be returned." + } + }, + "documentation":"Request for a list of datasets for an identity." + }, + "ListDatasetsResponse":{ + "type":"structure", + "members":{ + "Datasets":{ + "shape":"DatasetList", + "documentation":"A set of datasets." + }, + "Count":{ + "shape":"Integer", + "documentation":"Number of datasets returned." + }, + "NextToken":{ + "shape":"String", + "documentation":"A pagination token for obtaining the next page of results." + } + }, + "documentation":"Returned for a successful ListDatasets request." + }, + "ListIdentityPoolUsageRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"nextToken", + "documentation":"A pagination token for obtaining the next page of results." + }, + "MaxResults":{ + "shape":"IntegerString", + "location":"querystring", + "locationName":"maxResults", + "documentation":"The maximum number of results to be returned." + } + }, + "documentation":"A request for usage information on an identity pool." + }, + "ListIdentityPoolUsageResponse":{ + "type":"structure", + "members":{ + "IdentityPoolUsages":{ + "shape":"IdentityPoolUsageList", + "documentation":"Usage information for the identity pools." + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"The maximum number of results to be returned." + }, + "Count":{ + "shape":"Integer", + "documentation":"Total number of identities for the identity pool." + }, + "NextToken":{ + "shape":"String", + "documentation":"A pagination token for obtaining the next page of results." + } + }, + "documentation":"Returned for a successful ListIdentityPoolUsage request." + }, + "ListRecordsRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "LastSyncCount":{ + "shape":"Long", + "location":"querystring", + "locationName":"lastSyncCount", + "documentation":"The last server sync count for this record." + }, + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"nextToken", + "documentation":"A pagination token for obtaining the next page of results." + }, + "MaxResults":{ + "shape":"IntegerString", + "location":"querystring", + "locationName":"maxResults", + "documentation":"The maximum number of results to be returned." + }, + "SyncSessionToken":{ + "shape":"SyncSessionToken", + "location":"querystring", + "locationName":"syncSessionToken", + "documentation":"A token containing a session ID, identity ID, and expiration." + } + }, + "documentation":"A request for a list of records." + }, + "ListRecordsResponse":{ + "type":"structure", + "members":{ + "Records":{ + "shape":"RecordList", + "documentation":"A list of all records." + }, + "NextToken":{ + "shape":"String", + "documentation":"A pagination token for obtaining the next page of results." + }, + "Count":{ + "shape":"Integer", + "documentation":"Total number of records." + }, + "DatasetSyncCount":{ + "shape":"Long", + "documentation":"Server sync count for this dataset." + }, + "LastModifiedBy":{ + "shape":"String", + "documentation":"The user/device that made the last change to this record." + }, + "MergedDatasetNames":{ + "shape":"MergedDatasetNameList", + "documentation":"Names of merged datasets." + }, + "DatasetExists":{ + "shape":"Boolean", + "documentation":"Indicates whether the dataset exists." + }, + "DatasetDeletedAfterRequestedSyncCount":{ + "shape":"Boolean", + "documentation":"A boolean value specifying whether to delete the dataset locally." + }, + "SyncSessionToken":{ + "shape":"String", + "documentation":"A token containing a session ID, identity ID, and expiration." + } + }, + "documentation":"Returned for a successful ListRecordsRequest." + }, + "Long":{"type":"long"}, + "MergedDatasetNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "NotAuthorizedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The message returned by a NotAuthorizedException." + } + }, + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + "Operation":{ + "type":"string", + "enum":[ + "replace", + "remove" + ] + }, + "Record":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"RecordKey", + "documentation":"The key for the record." + }, + "Value":{ + "shape":"RecordValue", + "documentation":"The value for the record." + }, + "SyncCount":{ + "shape":"Long", + "documentation":"The server sync count for this record." + }, + "LastModifiedDate":{ + "shape":"Date", + "documentation":"The date on which the record was last modified." + }, + "LastModifiedBy":{ + "shape":"String", + "documentation":"The user/device that made the last change to this record." + }, + "DeviceLastModifiedDate":{ + "shape":"Date", + "documentation":"The last modified date of the client device." + } + }, + "documentation":"The basic data structure of a dataset." + }, + "RecordKey":{ + "type":"string", + "min":1, + "max":1024 + }, + "RecordList":{ + "type":"list", + "member":{"shape":"Record"} + }, + "RecordPatch":{ + "type":"structure", + "required":[ + "Op", + "Key", + "SyncCount" + ], + "members":{ + "Op":{ + "shape":"Operation", + "documentation":"An operation, either replace or remove." + }, + "Key":{ + "shape":"RecordKey", + "documentation":"The key associated with the record patch." + }, + "Value":{ + "shape":"RecordValue", + "documentation":"The value associated with the record patch." + }, + "SyncCount":{ + "shape":"Long", + "documentation":"Last known server sync count for this record. Set to 0 if unknown." + }, + "DeviceLastModifiedDate":{ + "shape":"Date", + "documentation":"The last modified date of the client device." + } + }, + "documentation":"An update operation for a record." + }, + "RecordPatchList":{ + "type":"list", + "member":{"shape":"RecordPatch"} + }, + "RecordValue":{ + "type":"string", + "max":1048575 + }, + "ResourceConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The message returned by a ResourceConflictException." + } + }, + "error":{ + "code":"ResourceConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by a ResourceNotFoundException." + } + }, + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + "String":{"type":"string"}, + "SyncSessionToken":{"type":"string"}, + "TooManyRequestsException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by a TooManyRequestsException." + } + }, + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + }, + "UpdateRecordsRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName", + "SyncSessionToken" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "RecordPatches":{ + "shape":"RecordPatchList", + "documentation":"A list of patch operations." + }, + "SyncSessionToken":{ + "shape":"SyncSessionToken", + "documentation":"The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity." + }, + "ClientContext":{ + "shape":"ClientContext", + "location":"header", + "locationName":"x-amz-Client-Context", + "documentation":"Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented." + } + }, + "documentation":"A request to post updates to records or add and delete records for a dataset and user." + }, + "UpdateRecordsResponse":{ + "type":"structure", + "members":{ + "Records":{ + "shape":"RecordList", + "documentation":"A list of records that have been updated." + } + }, + "documentation":"Returned for a successful UpdateRecordsRequest." + } + } +} diff --git a/apis/datapipeline-2012-10-29.api.json b/apis/datapipeline-2012-10-29.api.json new file mode 100644 index 0000000000..0643383819 --- /dev/null +++ b/apis/datapipeline-2012-10-29.api.json @@ -0,0 +1,518 @@ +{ + "metadata": { + "apiVersion": "2012-10-29", + "endpointPrefix": "datapipeline", + "jsonVersion": "1.1", + "serviceFullName": "AWS Data Pipeline", + "signatureVersion": "v4", + "targetPrefix": "DataPipeline", + "protocol": "json" + }, + "operations": { + "ActivatePipeline": { + "input": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreatePipeline": { + "input": { + "type": "structure", + "required": [ + "name", + "uniqueId" + ], + "members": { + "name": {}, + "uniqueId": {}, + "description": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {} + } + } + }, + "DeletePipeline": { + "input": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {} + } + } + }, + "DescribeObjects": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "objectIds" + ], + "members": { + "pipelineId": {}, + "objectIds": { + "shape": "S9" + }, + "evaluateExpressions": { + "type": "boolean" + }, + "marker": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pipelineObjects" + ], + "members": { + "pipelineObjects": { + "shape": "Sc" + }, + "marker": {}, + "hasMoreResults": { + "type": "boolean" + } + } + } + }, + "DescribePipelines": { + "input": { + "type": "structure", + "required": [ + "pipelineIds" + ], + "members": { + "pipelineIds": { + "shape": "S9" + } + } + }, + "output": { + "type": "structure", + "required": [ + "pipelineDescriptionList" + ], + "members": { + "pipelineDescriptionList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "pipelineId", + "name", + "fields" + ], + "members": { + "pipelineId": {}, + "name": {}, + "fields": { + "shape": "Se" + }, + "description": {} + } + } + } + } + } + }, + "EvaluateExpression": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "objectId", + "expression" + ], + "members": { + "pipelineId": {}, + "objectId": {}, + "expression": {} + } + }, + "output": { + "type": "structure", + "required": [ + "evaluatedExpression" + ], + "members": { + "evaluatedExpression": {} + } + } + }, + "GetPipelineDefinition": { + "input": { + "type": "structure", + "required": [ + "pipelineId" + ], + "members": { + "pipelineId": {}, + "version": {} + } + }, + "output": { + "type": "structure", + "members": { + "pipelineObjects": { + "shape": "Sc" + } + } + } + }, + "ListPipelines": { + "input": { + "type": "structure", + "members": { + "marker": {} + } + }, + "output": { + "type": "structure", + "required": [ + "pipelineIdList" + ], + "members": { + "pipelineIdList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "name": {} + } + } + }, + "marker": {}, + "hasMoreResults": { + "type": "boolean" + } + } + } + }, + "PollForTask": { + "input": { + "type": "structure", + "required": [ + "workerGroup" + ], + "members": { + "workerGroup": {}, + "hostname": {}, + "instanceIdentity": { + "type": "structure", + "members": { + "document": {}, + "signature": {} + } + } + } + }, + "output": { + "type": "structure", + "members": { + "taskObject": { + "type": "structure", + "members": { + "taskId": {}, + "pipelineId": {}, + "attemptId": {}, + "objects": { + "type": "map", + "key": {}, + "value": { + "shape": "Sd" + } + } + } + } + } + } + }, + "PutPipelineDefinition": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "pipelineObjects" + ], + "members": { + "pipelineId": {}, + "pipelineObjects": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "required": [ + "errored" + ], + "members": { + "validationErrors": { + "shape": "S13" + }, + "validationWarnings": { + "shape": "S17" + }, + "errored": { + "type": "boolean" + } + } + } + }, + "QueryObjects": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "sphere" + ], + "members": { + "pipelineId": {}, + "query": { + "type": "structure", + "members": { + "selectors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "fieldName": {}, + "operator": { + "type": "structure", + "members": { + "type": {}, + "values": { + "type": "list", + "member": {} + } + } + } + } + } + } + } + }, + "sphere": {}, + "marker": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ids": { + "shape": "S9" + }, + "marker": {}, + "hasMoreResults": { + "type": "boolean" + } + } + } + }, + "ReportTaskProgress": { + "input": { + "type": "structure", + "required": [ + "taskId" + ], + "members": { + "taskId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "canceled" + ], + "members": { + "canceled": { + "type": "boolean" + } + } + } + }, + "ReportTaskRunnerHeartbeat": { + "input": { + "type": "structure", + "required": [ + "taskrunnerId" + ], + "members": { + "taskrunnerId": {}, + "workerGroup": {}, + "hostname": {} + } + }, + "output": { + "type": "structure", + "required": [ + "terminate" + ], + "members": { + "terminate": { + "type": "boolean" + } + } + } + }, + "SetStatus": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "objectIds", + "status" + ], + "members": { + "pipelineId": {}, + "objectIds": { + "shape": "S9" + }, + "status": {} + } + } + }, + "SetTaskStatus": { + "input": { + "type": "structure", + "required": [ + "taskId", + "taskStatus" + ], + "members": { + "taskId": {}, + "taskStatus": {}, + "errorId": {}, + "errorMessage": {}, + "errorStackTrace": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ValidatePipelineDefinition": { + "input": { + "type": "structure", + "required": [ + "pipelineId", + "pipelineObjects" + ], + "members": { + "pipelineId": {}, + "pipelineObjects": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "required": [ + "errored" + ], + "members": { + "validationErrors": { + "shape": "S13" + }, + "validationWarnings": { + "shape": "S17" + }, + "errored": { + "type": "boolean" + } + } + } + } + }, + "shapes": { + "S9": { + "type": "list", + "member": {} + }, + "Sc": { + "type": "list", + "member": { + "shape": "Sd" + } + }, + "Sd": { + "type": "structure", + "required": [ + "id", + "name", + "fields" + ], + "members": { + "id": {}, + "name": {}, + "fields": { + "shape": "Se" + } + } + }, + "Se": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": {}, + "stringValue": {}, + "refValue": {} + } + } + }, + "S13": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "errors": { + "shape": "S15" + } + } + } + }, + "S15": { + "type": "list", + "member": {} + }, + "S17": { + "type": "list", + "member": { + "type": "structure", + "members": { + "id": {}, + "warnings": { + "shape": "S15" + } + } + } + } + } +} \ No newline at end of file diff --git a/apis/datapipeline-2012-10-29.full.json b/apis/datapipeline-2012-10-29.full.json new file mode 100644 index 0000000000..56d4bf1b27 --- /dev/null +++ b/apis/datapipeline-2012-10-29.full.json @@ -0,0 +1,1432 @@ +{ + "metadata":{ + "apiVersion":"2012-10-29", + "endpointPrefix":"datapipeline", + "jsonVersion":"1.1", + "serviceFullName":"AWS Data Pipeline", + "signatureVersion":"v4", + "targetPrefix":"DataPipeline", + "protocol":"json" + }, + "documentation":"

\n This is the AWS Data Pipeline API Reference. This guide provides descriptions and\n samples of the AWS Data Pipeline API.\n

\n \n

\n AWS Data Pipeline is a web service that configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so your application can focus on processing the data.

\n \n

\n The AWS Data Pipeline API implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You call these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data.\n

\n \n

\n The second set of actions are used by a task runner application that calls the AWS Data Pipeline API to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.\n

\n \n

\n AWS Data Pipeline provides an open-source implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.\n

\n \n \n

\n The AWS Data Pipeline API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see \n Signature Version 4 Signing Process. In the code examples in this reference, the Signature Version 4 Request parameters are represented as AuthParams.\n

", + "operations":{ + "ActivatePipeline":{ + "name":"ActivatePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ActivatePipelineInput", + "documentation":"

The input of the ActivatePipeline action.

" + }, + "output":{ + "shape":"ActivatePipelineOutput", + "documentation":"

Contains the output from the ActivatePipeline action.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

\n Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails.\n

\n

\n Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated. \n

\n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ActivatePipeline\nContent-Length: 39\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n \n \n \nHTTP/1.1 200 \nx-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 2\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{}\n \n \n " + }, + "CreatePipeline":{ + "name":"CreatePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreatePipelineInput", + "documentation":"

The input for the CreatePipeline action.

" + }, + "output":{ + "shape":"CreatePipelineOutput", + "documentation":"

Contains the output from the CreatePipeline action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.CreatePipeline\nContent-Length: 91\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"name\": \"myPipeline\",\n \"uniqueId\": \"123456789\",\n \"description\": \"This is my first pipeline\"}\n \n \n \n \n \nHTTP/1.1 200 \nx-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 40\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n \n \n " + }, + "DeletePipeline":{ + "name":"DeletePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeletePipelineInput", + "documentation":"

The input for the DeletePipeline action.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

\n Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone.\n

\n

\n To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to Pause on individual components. Components that are paused by SetStatus can be resumed.\n

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DeletePipeline\nContent-Length: 50\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n \n \n \n \nx-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\nUnexpected response: 200, OK, undefined\n \n \n " + }, + "DescribeObjects":{ + "name":"DescribeObjects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeObjectsInput", + "documentation":"

The DescribeObjects action returns the object definitions for a specified set of object identifiers. You can filter the results to named fields and used markers to page through the results.

" + }, + "output":{ + "shape":"DescribeObjectsOutput", + "documentation":"

If True, there are more results that can be returned in another call to DescribeObjects.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

\n Returns the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. \n

\n \n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribeObjects\nContent-Length: 98\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"objectIds\": \n [\"Schedule\"],\n \"evaluateExpressions\": true}\n\n \n \n \n\nx-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 1488\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"hasMoreResults\": false, \n \"pipelineObjects\": \n [\n {\"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"parent\", \n \"refValue\": \"Default\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"COMPONENT\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-12-21T18:00:00\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"@status\", \n \"stringValue\": \"PENDING\"}, \n {\"key\": \"@pipelineId\", \n \"stringValue\": \"df-06372391ZG65EXAMPLE\"}\n ], \n \"id\": \"Schedule\", \n \"name\": \"Schedule\"}\n ]\n}\n \n \n " + }, + "DescribePipelines":{ + "name":"DescribePipelines", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribePipelinesInput", + "documentation":"

The input to the DescribePipelines action.

" + }, + "output":{ + "shape":"DescribePipelinesOutput", + "documentation":"

Contains the output from the DescribePipelines action.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

\n Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read permission for.\n

\n

\n To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action.\n

\n \n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribePipelines\nContent-Length: 70\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineIds\": \n [\"df-08785951KAKJEXAMPLE\"]\n}\n\n \n \n\n \n \nx-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 767\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineDescriptionList\": \n [\n {\"description\": \"This is my first pipeline\", \n \"fields\": \n [\n {\"key\": \"@pipelineState\", \n \"stringValue\": \"SCHEDULED\"}, \n {\"key\": \"description\", \n \"stringValue\": \"This is my first pipeline\"}, \n {\"key\": \"name\", \n \"stringValue\": \"myPipeline\"}, \n {\"key\": \"@creationTime\", \n \"stringValue\": \"2012-12-13T01:24:06\"}, \n {\"key\": \"@id\", \n \"stringValue\": \"df-0937003356ZJEXAMPLE\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"PIPELINE\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"@userId\", \n \"stringValue\": \"924374875933\"}, \n {\"key\": \"@accountId\", \n \"stringValue\": \"924374875933\"}, \n {\"key\": \"uniqueId\", \n \"stringValue\": \"1234567890\"}\n ], \n \"name\": \"myPipeline\", \n \"pipelineId\": \"df-0937003356ZJEXAMPLE\"}\n ]\n}\n\n " + }, + "EvaluateExpression":{ + "name":"EvaluateExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"EvaluateExpressionInput", + "documentation":"

The input for the EvaluateExpression action.

" + }, + "output":{ + "shape":"EvaluateExpressionOutput", + "documentation":"

Contains the output from the EvaluateExpression action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"TaskNotFoundException", + "exception":true, + "documentation":"

The specified task was not found.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3.

\n \n \n \n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribePipelines\nContent-Length: 164\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-08785951KAKJEXAMPLE\",\n \"objectId\": \"Schedule\",\n \"expression\": \"Transform started at #{startDateTime} and finished at #{endDateTime}\"}\n\n \n \n \n \n \nx-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 103\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"evaluatedExpression\": \"Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00\"}\n\n " + }, + "GetPipelineDefinition":{ + "name":"GetPipelineDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetPipelineDefinitionInput", + "documentation":"

The input for the GetPipelineDefinition action.

" + }, + "output":{ + "shape":"GetPipelineDefinitionOutput", + "documentation":"

Contains the output from the GetPipelineDefinition action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Returns the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition you provided using PutPipelineDefinition.

\n\n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.GetPipelineDefinition\nContent-Length: 40\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n \n \n \nx-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 890\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineObjects\": \n [\n {\"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}\n ], \n \"id\": \"Default\", \n \"name\": \"Default\"}, \n {\"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ], \n \"id\": \"Schedule\", \n \"name\": \"Schedule\"}, \n {\"fields\": \n [\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}, \n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"}, \n {\"key\": \"parent\", \n \"refValue\": \"Default\"}, \n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"}\n ], \n \"id\": \"SayHello\", \n \"name\": \"SayHello\"}\n ]\n}\n\n \n " + }, + "ListPipelines":{ + "name":"ListPipelines", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListPipelinesInput", + "documentation":"

The input to the ListPipelines action.

" + }, + "output":{ + "shape":"ListPipelinesOutput", + "documentation":"

Contains the output from the ListPipelines action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ListPipelines\nContent-Length: 14\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{}\n\n \n \n \n \nStatus:\nx-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 39\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"PipelineIdList\": \n [\n {\"id\": \"df-08785951KAKJEXAMPLE\",\n \"name\": \"MyPipeline\"}, \n {\"id\": \"df-08662578ISYEXAMPLE\", \n \"name\": \"MySecondPipeline\"}\n ]\n} \n \n " + }, + "PollForTask":{ + "name":"PollForTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PollForTaskInput", + "documentation":"

The data type passed in as input to the PollForTask action.

" + }, + "output":{ + "shape":"PollForTaskOutput", + "documentation":"

Contains the output from the PollForTask action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"TaskNotFoundException", + "exception":true, + "documentation":"

The specified task was not found.

" + } + ], + "documentation":"

\n Task runners call this action to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter of the PollForTask call. The task returned by PollForTask may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.\n

\n

\n If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this may take up to 90 seconds.\n

\n\n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PollForTask\nContent-Length: 59\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"workerGroup\": \"MyworkerGroup\",\n \"hostname\": \"example.com\"}\n\n \n \n \n \nx-amzn-RequestId: 41c713d2-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 39\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"taskObject\": \n {\"attemptId\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\", \n \"objects\": \n {\"@SayHello_2012-12-12T00:00:00_Attempt=1\": \n {\"fields\": \n [\n {\"key\": \"@componentParent\", \n \"refValue\": \"SayHello\"}, \n {\"key\": \"@scheduledStartTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"parent\", \n \"refValue\": \"SayHello\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"ATTEMPT\"}, \n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}, \n {\"key\": \"@instanceParent\", \n \"refValue\": \"@SayHello_2012-12-12T00:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"}, \n {\"key\": \"@status\", \n \"stringValue\": \"WAITING_FOR_RUNNER\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}, \n {\"key\": \"@actualStartTime\", \n \"stringValue\": \"2012-12-13T01:40:50\"}, \n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"}, \n {\"key\": \"@scheduledEndTime\", \n \"stringValue\": \"2012-12-12T01:00:00\"}, \n {\"key\": \"@activeInstances\", \n \"refValue\": \"@SayHello_2012-12-12T00:00:00\"}, \n {\"key\": \"@pipelineId\", \n \"stringValue\": \"df-0937003356ZJEXAMPLE\"}\n ], \n \"id\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\", \n \"name\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\"}\n }, \n \"pipelineId\": \"df-0937003356ZJEXAMPLE\", \n \"taskId\": \"2xaM4wRs5zOsIH+g9U3oVHfAgAlbSqU6XduncB0HhZ3xMnmvfePZPn4dIbYXHyWyRK+cU15MqDHwdrvftx/4wv+sNS4w34vJfv7QA9aOoOazW28l1GYSb2ZRR0N0paiQp+d1MhSKo10hOTWOsVK5S5Lnx9Qm6omFgXHyIvZRIvTlrQMpr1xuUrflyGOfbFOGpOLpvPE172MYdqpZKnbSS4TcuqgQKSWV2833fEubI57DPOP7ghWa2TcYeSIv4pdLYG53fTuwfbnbdc98g2LNUQzSVhSnt7BoqyNwht2aQ6b/UHg9A80+KVpuXuqmz3m1MXwHFgxjdmuesXNOrrlGpeLCcRWD+aGo0RN1NqhQRzNAig8V4GlaPTQzMsRCljKqvrIyAoP3Tt2XEGsHkkQo12rEX8Z90957XX2qKRwhruwYzqGkSLWjINoLdAxUJdpRXRc5DJTrBd3D5mdzn7kY1l7NEh4kFHJDt3Cx4Z3Mk8MYCACyCk/CEyy9DwuPi66cLz0NBcgbCM5LKjTBOwo1m+am+pvM1kSposE9FPP1+RFGb8k6jQBTJx3TRz1yKilnGXQTZ5xvdOFpJrklIT0OXP1MG3+auM9FlJA+1dX90QoNJE5z7axmK//MOGXUdkqFe2kiDkorqjxwDvc0Js9pVKfKvAmW8YqUbmI9l0ERpWCXXnLVHNmPWz3jaPY+OBAmuJWDmxB/Z8p94aEDg4BVXQ7LvsKQ3DLYhaB7yJ390CJT+i0mm+EBqY60V6YikPSWDFrYQ/NPi2b1DgE19mX8zHqw8qprIl4yh1Ckx2Iige4En/N5ktOoIxnASxAw/TzcE2skxdw5KlHDF+UTj71m16CR/dIaKlXijlfNlNzUBo/bNSadCQn3G5NoO501wPKI:XO50TgDNyo8EXAMPLE/g==:1\"}\n}\n \n \n " + }, + "PutPipelineDefinition":{ + "name":"PutPipelineDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PutPipelineDefinitionInput", + "documentation":"

The input of the PutPipelineDefinition action.

" + }, + "output":{ + "shape":"PutPipelineDefinitionOutput", + "documentation":"

Contains the output of the PutPipelineDefinition action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline.\n

\n

\n PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.\n

    \n
  1. An object is missing a name or identifier field.
    2. \n
  2. A string or reference field is empty.
    3. \n
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
    4. \n
\n

\n

\n Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. \n

\n \n \n Example 1\n \n This example sets an valid pipeline configuration and returns success.\n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PutPipelineDefinition\nContent-Length: 914\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-0937003356ZJEXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-12-21T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n ]\n }\n ]\n}\n \n \n \n \nHTTP/1.1 200 \nx-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": false}\n\n \n \n \n \n Example 2\n \n This example sets an invalid pipeline configuration (the value for workerGroup is an empty string) and returns an error message.\n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PutPipelineDefinition\nContent-Length: 903\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n \n \n \nHTTP/1.1 200 \nx-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"__type\": \"com.amazon.setl.webservice#InvalidRequestException\", \n \"message\": \"Pipeline definition has errors: Could not save the pipeline definition due to FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate to validate your pipeline\"}\n\n \n \n \n " + }, + "QueryObjects":{ + "name":"QueryObjects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"QueryObjectsInput", + "documentation":"

The input for the QueryObjects action.

" + }, + "output":{ + "shape":"QueryObjectsOutput", + "documentation":"

Contains the output from the QueryObjects action.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Queries a pipeline for the names of objects that match a specified set of conditions.

\n \n

The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If HasMoreResults is set to True, you should continue to call QueryObjects, passing in the returned value for marker, until HasMoreResults returns False.

\n\n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.QueryObjects\nContent-Length: 123\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"query\": \n {\"selectors\": \n [\n ]\n },\n \"sphere\": \"PO\",\n \"marker\": \"\",\n \"limit\": 10}\n\n \n \n \n \n\nx-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 72\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"hasMoreResults\": false, \n \"ids\": \n [\"@SayHello_1_2012-09-25T17:00:00\"]\n}\n \n " + }, + "ReportTaskProgress":{ + "name":"ReportTaskProgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ReportTaskProgressInput", + "documentation":"

The input for the ReportTaskProgress action.

" + }, + "output":{ + "shape":"ReportTaskProgressOutput", + "documentation":"

Contains the output from the ReportTaskProgress action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"TaskNotFoundException", + "exception":true, + "documentation":"

The specified task was not found.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

\n Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.\n \n \n \n If a task runner does not report its status after 5 minutes, AWS Data Pipeline will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask. task runners should call ReportTaskProgress every 60 seconds.\n

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ReportTaskProgress\nContent-Length: 832\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskId\": \"aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE\",\n \"fields\": \n [\n {\"key\": \"percentComplete\",\n \"stringValue\": \"50\"}\n ]\n}\n\n \n \n \n\nx-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"canceled\": false}\n \n\n " + }, + "ReportTaskRunnerHeartbeat":{ + "name":"ReportTaskRunnerHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ReportTaskRunnerHeartbeatInput", + "documentation":"

The input for the ReportTaskRunnerHeartbeat action.

" + }, + "output":{ + "shape":"ReportTaskRunnerHeartbeatOutput", + "documentation":"

Contains the output from the ReportTaskRunnerHeartbeat action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat\nContent-Length: 84\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskrunnerId\": \"1234567890\",\n \"workerGroup\": \"wg-12345\",\n \"hostname\": \"example.com\"}\n\n \n \n \n\nStatus:\nx-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 20\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"terminate\": false}\n \n \n " + }, + "SetStatus":{ + "name":"SetStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetStatusInput", + "documentation":"

The input to the SetStatus action.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.SetStatus\nContent-Length: 100\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-0634701J7KEXAMPLE\", \n \"objectIds\": \n [\"o-08600941GHJWMBR9E2\"], \n \"status\": \"pause\"}\n\n \n \n \n\nx-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\nUnexpected response: 200, OK, undefined\n \n \n " + }, + "SetTaskStatus":{ + "name":"SetTaskStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetTaskStatusInput", + "documentation":"

The input of the SetTaskStatus action.

" + }, + "output":{ + "shape":"SetTaskStatusOutput", + "documentation":"

The output from the SetTaskStatus action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"TaskNotFoundException", + "exception":true, + "documentation":"

The specified task was not found.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

\n Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.\n

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.SetTaskStatus\nContent-Length: 847\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskId\": \"aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE\",\n \"taskStatus\": \"FINISHED\"}\n \n \n \n \n\nx-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8 \nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{}\n \n \n " + }, + "ValidatePipelineDefinition":{ + "name":"ValidatePipelineDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ValidatePipelineDefinitionInput", + "documentation":"

The input of the ValidatePipelineDefinition action.

" + }, + "output":{ + "shape":"ValidatePipelineDefinitionOutput", + "documentation":"

Contains the output from the ValidatePipelineDefinition action.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.

\n\n \n \n Example 1\n \n This example sets an valid pipeline configuration and returns success.\n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ValidatePipelineDefinition\nContent-Length: 936\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"MyworkerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n \n \n \nx-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": false}\n \n \n \n \n Example 2\n \n This example sets an invalid pipeline configuration and returns the associated set of validation errors.\n \n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ValidatePipelineDefinition\nContent-Length: 903\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"MyworkerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"bad-time\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n \n \n \nx-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd\nContent-Type: application/x-amz-json-1.1\nContent-Length: 278\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": true, \n \"validationErrors\": \n [\n {\"errors\": \n [\"INVALID_FIELD_VALUE: 'startDateTime' value must be a literal datetime value.\"], \n \"id\": \"Schedule\"}\n ]\n}\n \n \n \n " + } + }, + "shapes":{ + "ActivatePipelineInput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The identifier of the pipeline to activate.

" + } + }, + "documentation":"

The input of the ActivatePipeline action.

" + }, + "ActivatePipelineOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output from the ActivatePipeline action.

" + }, + "CreatePipelineInput":{ + "type":"structure", + "required":[ + "name", + "uniqueId" + ], + "members":{ + "name":{ + "shape":"id", + "documentation":"

\n The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.\n

" + }, + "uniqueId":{ + "shape":"id", + "documentation":"

\n A unique identifier that you specify. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not return a clear success, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline will not be created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.\n

" + }, + "description":{ + "shape":"string", + "documentation":"

The description of the new pipeline.

" + } + }, + "documentation":"

The input for the CreatePipeline action.

" + }, + "CreatePipelineOutput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID that AWS Data Pipeline assigns the newly created pipeline. The ID is a string of the form: df-06372391ZG65EXAMPLE.

" + } + }, + "documentation":"

Contains the output from the CreatePipeline action.

" + }, + "DeletePipelineInput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The identifier of the pipeline to be deleted.

" + } + }, + "documentation":"

The input for the DeletePipeline action.

" + }, + "DescribeObjectsInput":{ + "type":"structure", + "required":[ + "pipelineId", + "objectIds" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

Identifier of the pipeline that contains the object definitions.

" + }, + "objectIds":{ + "shape":"idList", + "documentation":"

Identifiers of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

" + }, + "evaluateExpressions":{ + "shape":"boolean", + "documentation":"

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

" + }, + "marker":{ + "shape":"string", + "documentation":"

The starting point for the results to be returned. The first time you call DescribeObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call DescribeObjects again and pass the marker value from the response to retrieve the next set of results.

" + } + }, + "documentation":"

The DescribeObjects action returns the object definitions for a specified set of object identifiers. You can filter the results to named fields and used markers to page through the results.

" + }, + "DescribeObjectsOutput":{ + "type":"structure", + "required":["pipelineObjects"], + "members":{ + "pipelineObjects":{ + "shape":"PipelineObjectList", + "documentation":"

An array of object definitions that are returned by the call to DescribeObjects.

" + }, + "marker":{ + "shape":"string", + "documentation":"

\n The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value.\n

" + }, + "hasMoreResults":{ + "shape":"boolean", + "documentation":"

If True, there are more pages of results to return.

" + } + }, + "documentation":"

If True, there are more results that can be returned in another call to DescribeObjects.

" + }, + "DescribePipelinesInput":{ + "type":"structure", + "required":["pipelineIds"], + "members":{ + "pipelineIds":{ + "shape":"idList", + "documentation":"

Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

" + } + }, + "documentation":"

The input to the DescribePipelines action.

" + }, + "DescribePipelinesOutput":{ + "type":"structure", + "required":["pipelineDescriptionList"], + "members":{ + "pipelineDescriptionList":{ + "shape":"PipelineDescriptionList", + "documentation":"

An array of descriptions returned for the specified pipelines.

" + } + }, + "documentation":"

Contains the output from the DescribePipelines action.

" + }, + "EvaluateExpressionInput":{ + "type":"structure", + "required":[ + "pipelineId", + "objectId", + "expression" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The identifier of the pipeline.

" + }, + "objectId":{ + "shape":"id", + "documentation":"

The identifier of the object.

" + }, + "expression":{ + "shape":"longString", + "documentation":"

The expression to evaluate.

" + } + }, + "documentation":"

The input for the EvaluateExpression action.

" + }, + "EvaluateExpressionOutput":{ + "type":"structure", + "required":["evaluatedExpression"], + "members":{ + "evaluatedExpression":{ + "shape":"longString", + "documentation":"

The evaluated expression.

" + } + }, + "documentation":"

Contains the output from the EvaluateExpression action.

" + }, + "Field":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"fieldNameString", + "documentation":"

The field identifier.

" + }, + "stringValue":{ + "shape":"fieldStringValue", + "documentation":"

The field value, expressed as a String.

" + }, + "refValue":{ + "shape":"fieldNameString", + "documentation":"

The field value, expressed as the identifier of another object.

" + } + }, + "documentation":"

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.

" + }, + "GetPipelineDefinitionInput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The identifier of the pipeline.

" + }, + "version":{ + "shape":"string", + "documentation":"

The version of the pipeline definition to retrieve. This parameter accepts the values latest (default) and active. Where latest indicates the last definition saved to the pipeline and active indicates the last definition of the pipeline that was activated.

" + } + }, + "documentation":"

The input for the GetPipelineDefinition action.

" + }, + "GetPipelineDefinitionOutput":{ + "type":"structure", + "members":{ + "pipelineObjects":{ + "shape":"PipelineObjectList", + "documentation":"

An array of objects defined in the pipeline.

" + } + }, + "documentation":"

Contains the output from the GetPipelineDefinition action.

" + }, + "InstanceIdentity":{ + "type":"structure", + "members":{ + "document":{ + "shape":"string", + "documentation":"

A description of an Amazon EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.

" + }, + "signature":{ + "shape":"string", + "documentation":"

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

" + } + }, + "documentation":"

Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

" + }, + "InternalServiceError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + "ListPipelinesInput":{ + "type":"structure", + "members":{ + "marker":{ + "shape":"string", + "documentation":"

The starting point for the results to be returned. The first time you call ListPipelines, this value should be empty. As long as the action returns HasMoreResults as True, you can call ListPipelines again and pass the marker value from the response to retrieve the next set of results.

" + } + }, + "documentation":"

The input to the ListPipelines action.

" + }, + "ListPipelinesOutput":{ + "type":"structure", + "required":["pipelineIdList"], + "members":{ + "pipelineIdList":{ + "shape":"pipelineList", + "documentation":"

\n A list of all the pipeline identifiers that your account has permission to access. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.\n

" + }, + "marker":{ + "shape":"string", + "documentation":"

If not null, indicates the starting point for the set of pipeline identifiers that the next call to ListPipelines will retrieve. If null, there are no more pipeline identifiers.

" + }, + "hasMoreResults":{ + "shape":"boolean", + "documentation":"

If True, there are more results that can be obtained by a subsequent call to ListPipelines.

" + } + }, + "documentation":"

Contains the output from the ListPipelines action.

" + }, + "Operator":{ + "type":"structure", + "members":{ + "type":{ + "shape":"OperatorType", + "documentation":"

\n The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. \n

\n

\n The comparison operators EQ and REF_EQ act on the following fields:\n

\n \n \n

\n The comparison operators GE, LE, and BETWEEN act on the following fields:\n

\n \n

Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string \"my\".

" + }, + "values":{ + "shape":"stringList", + "documentation":"

The value that the actual field value will be compared with.

" + } + }, + "documentation":"

Contains a logical operation for comparing the value of a field with a specified value.

" + }, + "OperatorType":{ + "type":"string", + "enum":[ + "EQ", + "REF_EQ", + "LE", + "GE", + "BETWEEN" + ] + }, + "PipelineDeletedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + "PipelineDescription":{ + "type":"structure", + "required":[ + "pipelineId", + "name", + "fields" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

" + }, + "name":{ + "shape":"id", + "documentation":"

Name of the pipeline.

" + }, + "fields":{ + "shape":"fieldList", + "documentation":"

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

" + }, + "description":{ + "shape":"string", + "documentation":"

Description of the pipeline.

" + } + }, + "documentation":"

Contains pipeline metadata.

" + }, + "PipelineDescriptionList":{ + "type":"list", + "member":{"shape":"PipelineDescription"} + }, + "PipelineIdName":{ + "type":"structure", + "members":{ + "id":{ + "shape":"id", + "documentation":"

Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

" + }, + "name":{ + "shape":"id", + "documentation":"

Name of the pipeline.

" + } + }, + "documentation":"

Contains the name and identifier of a pipeline.

" + }, + "PipelineNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + "PipelineObject":{ + "type":"structure", + "required":[ + "id", + "name", + "fields" + ], + "members":{ + "id":{ + "shape":"id", + "documentation":"

Identifier of the object.

" + }, + "name":{ + "shape":"id", + "documentation":"

Name of the object.

" + }, + "fields":{ + "shape":"fieldList", + "documentation":"

Key-value pairs that define the properties of the object.

" + } + }, + "documentation":"

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

" + }, + "PipelineObjectList":{ + "type":"list", + "member":{"shape":"PipelineObject"} + }, + "PipelineObjectMap":{ + "type":"map", + "key":{"shape":"id"}, + "value":{"shape":"PipelineObject"} + }, + "PollForTaskInput":{ + "type":"structure", + "required":["workerGroup"], + "members":{ + "workerGroup":{ + "shape":"string", + "documentation":"

Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup, the string must be an exact, case-sensitive, match.\n

" + }, + "hostname":{ + "shape":"id", + "documentation":"

The public DNS name of the calling task runner.

" + }, + "instanceIdentity":{ + "shape":"InstanceIdentity", + "documentation":"

Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, http://169.254.169.254/latest/meta-data/instance-id, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

" + } + }, + "documentation":"

The data type passed in as input to the PollForTask action.

" + }, + "PollForTaskOutput":{ + "type":"structure", + "members":{ + "taskObject":{ + "shape":"TaskObject", + "documentation":"

An instance of PollForTaskResult, which contains an instance of TaskObject. The returned object contains all the information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus.

" + } + }, + "documentation":"

Contains the output from the PollForTask action.

" + }, + "PutPipelineDefinitionInput":{ + "type":"structure", + "required":[ + "pipelineId", + "pipelineObjects" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The identifier of the pipeline to be configured.

" + }, + "pipelineObjects":{ + "shape":"PipelineObjectList", + "documentation":"

The objects that define the pipeline. These will overwrite the existing pipeline definition.

" + } + }, + "documentation":"

The input of the PutPipelineDefinition action.

" + }, + "PutPipelineDefinitionOutput":{ + "type":"structure", + "required":["errored"], + "members":{ + "validationErrors":{ + "shape":"ValidationErrors", + "documentation":"

A list of the validation errors that are associated with the objects defined in pipelineObjects.

" + }, + "validationWarnings":{ + "shape":"ValidationWarnings", + "documentation":"

A list of the validation warnings that are associated with the objects defined in pipelineObjects.

" + }, + "errored":{ + "shape":"boolean", + "documentation":"

If True, there were validation errors. If errored is True, the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.

" + } + }, + "documentation":"

Contains the output of the PutPipelineDefinition action.

" + }, + "Query":{ + "type":"structure", + "members":{ + "selectors":{ + "shape":"SelectorList", + "documentation":"

List of selectors that define the query. An object must satisfy all of the selectors to match the query.

" + } + }, + "documentation":"

Defines the query to run against an object.

" + }, + "QueryObjectsInput":{ + "type":"structure", + "required":[ + "pipelineId", + "sphere" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

Identifier of the pipeline to be queried for object names.

" + }, + "query":{ + "shape":"Query", + "documentation":"

\n Query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. \n The conditions in the query are limited to top-level String fields in the object. \n These filters can be applied to components, instances, and attempts. \n

" + }, + "sphere":{ + "shape":"string", + "documentation":"

\n Specifies whether the query applies to components or instances.\t\n Allowable values: COMPONENT, INSTANCE, ATTEMPT.\n

" + }, + "marker":{ + "shape":"string", + "documentation":"

\n The starting point for the results to be returned. The first time you call QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.\n

" + }, + "limit":{ + "shape":"int", + "documentation":"

Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.

" + } + }, + "documentation":"

The input for the QueryObjects action.

" + }, + "QueryObjectsOutput":{ + "type":"structure", + "members":{ + "ids":{ + "shape":"idList", + "documentation":"

A list of identifiers that match the query selectors.

" + }, + "marker":{ + "shape":"string", + "documentation":"

\n The starting point for the results to be returned. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.\n

" + }, + "hasMoreResults":{ + "shape":"boolean", + "documentation":"

If True, there are more results that can be obtained by a subsequent call to QueryObjects.

" + } + }, + "documentation":"

Contains the output from the QueryObjects action.

" + }, + "ReportTaskProgressInput":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"taskId", + "documentation":"

Identifier of the task assigned to the task runner. This value is provided in the TaskObject that the service returns with the response for the PollForTask action.

" + } + }, + "documentation":"

The input for the ReportTaskProgress action.

" + }, + "ReportTaskProgressOutput":{ + "type":"structure", + "required":["canceled"], + "members":{ + "canceled":{ + "shape":"boolean", + "documentation":"

If True, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.

" + } + }, + "documentation":"

Contains the output from the ReportTaskProgress action.

" + }, + "ReportTaskRunnerHeartbeatInput":{ + "type":"structure", + "required":["taskrunnerId"], + "members":{ + "taskrunnerId":{ + "shape":"id", + "documentation":"

The identifier of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

" + }, + "workerGroup":{ + "shape":"string", + "documentation":"

Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to ReportTaskRunnerHeartbeat. There are no wildcard values permitted in workerGroup, the string must be an exact, case-sensitive, match.

" + }, + "hostname":{ + "shape":"id", + "documentation":"

The public DNS name of the calling task runner.

" + } + }, + "documentation":"

The input for the ReportTaskRunnerHeartbeat action.

" + }, + "ReportTaskRunnerHeartbeatOutput":{ + "type":"structure", + "required":["terminate"], + "members":{ + "terminate":{ + "shape":"boolean", + "documentation":"

Indicates whether the calling task runner should terminate. If True, the task runner that called ReportTaskRunnerHeartbeat should terminate.

" + } + }, + "documentation":"

Contains the output from the ReportTaskRunnerHeartbeat action.

" + }, + "Selector":{ + "type":"structure", + "members":{ + "fieldName":{ + "shape":"string", + "documentation":"

The name of the field that the operator will be applied to. The field name is the \"key\" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.

" + }, + "operator":{"shape":"Operator"} + }, + "documentation":"

A comparision that is used to determine whether a query should return this object.

" + }, + "SelectorList":{ + "type":"list", + "member":{"shape":"Selector"}, + "documentation":"

The list of Selectors that define queries on individual fields.

" + }, + "SetStatusInput":{ + "type":"structure", + "required":[ + "pipelineId", + "objectIds", + "status" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

Identifies the pipeline that contains the objects.

" + }, + "objectIds":{ + "shape":"idList", + "documentation":"

Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.

" + }, + "status":{ + "shape":"string", + "documentation":"

Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either CANCEL, RERUN, or MARK_FINISHED.

" + } + }, + "documentation":"

The input to the SetStatus action.

" + }, + "SetTaskStatusInput":{ + "type":"structure", + "required":[ + "taskId", + "taskStatus" + ], + "members":{ + "taskId":{ + "shape":"taskId", + "documentation":"

Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

" + }, + "taskStatus":{ + "shape":"TaskStatus", + "documentation":"

If FINISHED, the task successfully completed. If FAILED the task ended unsuccessfully. The FALSE value is used by preconditions.

" + }, + "errorId":{ + "shape":"string", + "documentation":"

If an error occurred during the task, this value specifies an id value that represents the error. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.

" + }, + "errorMessage":{ + "shape":"errorMessage", + "documentation":"

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

" + }, + "errorStackTrace":{ + "shape":"string", + "documentation":"

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

" + } + }, + "documentation":"

The input of the SetTaskStatus action.

" + }, + "SetTaskStatusOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output from the SetTaskStatus action.

" + }, + "TaskNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "documentation":"

The specified task was not found.

" + }, + "TaskObject":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"taskId", + "documentation":"

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

" + }, + "pipelineId":{ + "shape":"id", + "documentation":"

Identifier of the pipeline that provided the task.

" + }, + "attemptId":{ + "shape":"id", + "documentation":"

Identifier of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

" + }, + "objects":{ + "shape":"PipelineObjectMap", + "documentation":"

Connection information for the location where the task runner will publish the output of the task.

" + } + }, + "documentation":"

Contains information about a pipeline task that is assigned to a task runner.

" + }, + "TaskStatus":{ + "type":"string", + "enum":[ + "FINISHED", + "FAILED", + "FALSE" + ] + }, + "ValidatePipelineDefinitionInput":{ + "type":"structure", + "required":[ + "pipelineId", + "pipelineObjects" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

Identifies the pipeline whose definition is to be validated.

" + }, + "pipelineObjects":{ + "shape":"PipelineObjectList", + "documentation":"

A list of objects that define the pipeline changes to validate against the pipeline.

" + } + }, + "documentation":"

The input of the ValidatePipelineDefinition action.

" + }, + "ValidatePipelineDefinitionOutput":{ + "type":"structure", + "required":["errored"], + "members":{ + "validationErrors":{ + "shape":"ValidationErrors", + "documentation":"

Lists the validation errors that were found by ValidatePipelineDefinition.

" + }, + "validationWarnings":{ + "shape":"ValidationWarnings", + "documentation":"

Lists the validation warnings that were found by ValidatePipelineDefinition.

" + }, + "errored":{ + "shape":"boolean", + "documentation":"

If True, there were validation errors.

" + } + }, + "documentation":"

Contains the output from the ValidatePipelineDefinition action.

" + }, + "ValidationError":{ + "type":"structure", + "members":{ + "id":{ + "shape":"id", + "documentation":"

The identifier of the object that contains the validation error.

" + }, + "errors":{ + "shape":"validationMessages", + "documentation":"

A description of the validation error.

" + } + }, + "documentation":"

Defines a validation error returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

" + }, + "ValidationErrors":{ + "type":"list", + "member":{"shape":"ValidationError"} + }, + "ValidationWarning":{ + "type":"structure", + "members":{ + "id":{ + "shape":"id", + "documentation":"

The identifier of the object that contains the validation warning.

" + }, + "warnings":{ + "shape":"validationMessages", + "documentation":"

A description of the validation warning.

" + } + }, + "documentation":"

Defines a validation warning returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.

" + }, + "ValidationWarnings":{ + "type":"list", + "member":{"shape":"ValidationWarning"} + }, + "boolean":{"type":"boolean"}, + "errorMessage":{"type":"string"}, + "fieldList":{ + "type":"list", + "member":{"shape":"Field"} + }, + "fieldNameString":{ + "type":"string", + "min":1, + "max":256, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "fieldStringValue":{ + "type":"string", + "min":0, + "max":10240, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "id":{ + "type":"string", + "min":1, + "max":1024, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "idList":{ + "type":"list", + "member":{"shape":"id"} + }, + "int":{"type":"integer"}, + "longString":{ + "type":"string", + "min":0, + "max":20971520, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "pipelineList":{ + "type":"list", + "member":{"shape":"PipelineIdName"} + }, + "string":{ + "type":"string", + "min":0, + "max":1024, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "stringList":{ + "type":"list", + "member":{"shape":"string"} + }, + "taskId":{ + "type":"string", + "min":1, + "max":2048, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "validationMessage":{ + "type":"string", + "min":0, + "max":10000, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "validationMessages":{ + "type":"list", + "member":{"shape":"validationMessage"} + } + } +} diff --git a/apis/datapipeline-2012-10-29.paginators.json b/apis/datapipeline-2012-10-29.paginators.json new file mode 100644 index 0000000000..db941936bc --- /dev/null +++ b/apis/datapipeline-2012-10-29.paginators.json @@ -0,0 +1,26 @@ +{ + "pagination": { + "ListPipelines": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "result_key": "pipelineIdList" + }, + "DescribeObjects": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "result_key": "pipelineObjects" + }, + "DescribePipelines": { + "result_key": "pipelineDescriptionList" + }, + "QueryObjects": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "limit_key": "limit", + "result_key": "ids" + } + } +} diff --git a/apis/directconnect-2012-10-25.api.json b/apis/directconnect-2012-10-25.api.json new file mode 100644 index 0000000000..ccd76b905a --- /dev/null +++ b/apis/directconnect-2012-10-25.api.json @@ -0,0 +1,505 @@ +{ + "metadata": { + "apiVersion": "2012-10-25", + "endpointPrefix": "directconnect", + "jsonVersion": "1.1", + "serviceFullName": "AWS Direct Connect", + "signatureVersion": "v4", + "targetPrefix": "OvertureService", + "protocol": "json" + }, + "operations": { + "AllocateConnectionOnInterconnect": { + "input": { + "type": "structure", + "required": [ + "bandwidth", + "connectionName", + "ownerAccount", + "interconnectId", + "vlan" + ], + "members": { + "bandwidth": {}, + "connectionName": {}, + "ownerAccount": {}, + "interconnectId": {}, + "vlan": { + "type": "integer" + } + } + }, + "output": { + "shape": "S7" + } + }, + "AllocatePrivateVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "ownerAccount", + "newPrivateVirtualInterfaceAllocation" + ], + "members": { + "connectionId": {}, + "ownerAccount": {}, + "newPrivateVirtualInterfaceAllocation": { + "type": "structure", + "required": [ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {} + } + } + } + }, + "output": { + "shape": "Sk" + } + }, + "AllocatePublicVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "ownerAccount", + "newPublicVirtualInterfaceAllocation" + ], + "members": { + "connectionId": {}, + "ownerAccount": {}, + "newPublicVirtualInterfaceAllocation": { + "type": "structure", + "required": [ + "virtualInterfaceName", + "vlan", + "asn", + "amazonAddress", + "customerAddress", + "routeFilterPrefixes" + ], + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "routeFilterPrefixes": { + "shape": "Sq" + } + } + } + } + }, + "output": { + "shape": "Sk" + } + }, + "ConfirmConnection": { + "input": { + "type": "structure", + "required": [ + "connectionId" + ], + "members": { + "connectionId": {} + } + }, + "output": { + "type": "structure", + "members": { + "connectionState": {} + } + } + }, + "ConfirmPrivateVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId", + "virtualGatewayId" + ], + "members": { + "virtualInterfaceId": {}, + "virtualGatewayId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaceState": {} + } + } + }, + "ConfirmPublicVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId" + ], + "members": { + "virtualInterfaceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaceState": {} + } + } + }, + "CreateConnection": { + "input": { + "type": "structure", + "required": [ + "location", + "bandwidth", + "connectionName" + ], + "members": { + "location": {}, + "bandwidth": {}, + "connectionName": {} + } + }, + "output": { + "shape": "S7" + } + }, + "CreateInterconnect": { + "input": { + "type": "structure", + "required": [ + "interconnectName", + "bandwidth", + "location" + ], + "members": { + "interconnectName": {}, + "bandwidth": {}, + "location": {} + } + }, + "output": { + "shape": "S14" + } + }, + "CreatePrivateVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "newPrivateVirtualInterface" + ], + "members": { + "connectionId": {}, + "newPrivateVirtualInterface": { + "type": "structure", + "required": [ + "virtualInterfaceName", + "vlan", + "asn", + "virtualGatewayId" + ], + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "virtualGatewayId": {} + } + } + } + }, + "output": { + "shape": "Sk" + } + }, + "CreatePublicVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "connectionId", + "newPublicVirtualInterface" + ], + "members": { + "connectionId": {}, + "newPublicVirtualInterface": { + "type": "structure", + "required": [ + "virtualInterfaceName", + "vlan", + "asn", + "amazonAddress", + "customerAddress", + "routeFilterPrefixes" + ], + "members": { + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "routeFilterPrefixes": { + "shape": "Sq" + } + } + } + } + }, + "output": { + "shape": "Sk" + } + }, + "DeleteConnection": { + "input": { + "type": "structure", + "required": [ + "connectionId" + ], + "members": { + "connectionId": {} + } + }, + "output": { + "shape": "S7" + } + }, + "DeleteInterconnect": { + "input": { + "type": "structure", + "required": [ + "interconnectId" + ], + "members": { + "interconnectId": {} + } + }, + "output": { + "type": "structure", + "members": { + "interconnectState": {} + } + } + }, + "DeleteVirtualInterface": { + "input": { + "type": "structure", + "required": [ + "virtualInterfaceId" + ], + "members": { + "virtualInterfaceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaceState": {} + } + } + }, + "DescribeConnections": { + "input": { + "type": "structure", + "members": { + "connectionId": {} + } + }, + "output": { + "shape": "S1g" + } + }, + "DescribeConnectionsOnInterconnect": { + "input": { + "type": "structure", + "required": [ + "interconnectId" + ], + "members": { + "interconnectId": {} + } + }, + "output": { + "shape": "S1g" + } + }, + "DescribeInterconnects": { + "input": { + "type": "structure", + "members": { + "interconnectId": {} + } + }, + "output": { + "type": "structure", + "members": { + "interconnects": { + "type": "list", + "member": { + "shape": "S14" + } + } + } + } + }, + "DescribeLocations": { + "output": { + "type": "structure", + "members": { + "locations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "locationCode": {}, + "locationName": {} + } + } + } + } + } + }, + "DescribeVirtualGateways": { + "output": { + "type": "structure", + "members": { + "virtualGateways": { + "type": "list", + "member": { + "type": "structure", + "members": { + "virtualGatewayId": {}, + "virtualGatewayState": {} + } + } + } + } + } + }, + "DescribeVirtualInterfaces": { + "input": { + "type": "structure", + "members": { + "connectionId": {}, + "virtualInterfaceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "virtualInterfaces": { + "type": "list", + "member": { + "shape": "Sk" + } + } + } + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "members": { + "ownerAccount": {}, + "connectionId": {}, + "connectionName": {}, + "connectionState": {}, + "region": {}, + "location": {}, + "bandwidth": {}, + "vlan": { + "type": "integer" + }, + "partnerName": {} + } + }, + "Sk": { + "type": "structure", + "members": { + "ownerAccount": {}, + "virtualInterfaceId": {}, + "location": {}, + "connectionId": {}, + "virtualInterfaceType": {}, + "virtualInterfaceName": {}, + "vlan": { + "type": "integer" + }, + "asn": { + "type": "integer" + }, + "authKey": {}, + "amazonAddress": {}, + "customerAddress": {}, + "virtualInterfaceState": {}, + "customerRouterConfig": {}, + "virtualGatewayId": {}, + "routeFilterPrefixes": { + "shape": "Sq" + } + } + }, + "Sq": { + "type": "list", + "member": { + "type": "structure", + "members": { + "cidr": {} + } + } + }, + "S14": { + "type": "structure", + "members": { + "interconnectId": {}, + "interconnectName": {}, + "interconnectState": {}, + "region": {}, + "location": {}, + "bandwidth": {} + } + }, + "S1g": { + "type": "structure", + "members": { + "connections": { + "type": "list", + "member": { + "shape": "S7" + } + } + } + } + } +} \ No newline at end of file diff --git a/apis/directconnect-2012-10-25.full.json b/apis/directconnect-2012-10-25.full.json new file mode 100644 index 0000000000..1d41ea2f06 --- /dev/null +++ b/apis/directconnect-2012-10-25.full.json @@ -0,0 +1,1174 @@ +{ + "metadata":{ + "apiVersion":"2012-10-25", + "endpointPrefix":"directconnect", + "jsonVersion":"1.1", + "serviceFullName":"AWS Direct Connect", + "signatureVersion":"v4", + "targetPrefix":"OvertureService", + "protocol":"json" + }, + "documentation":"

AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections.

\n\n

The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the AWS Direct Connect API Reference:

\n ", + "operations":{ + "AllocateConnectionOnInterconnect":{ + "name":"AllocateConnectionOnInterconnect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AllocateConnectionOnInterconnectRequest", + "documentation":"

Container for the parameters to the AllocateConnectionOnInterconnect operation.

" + }, + "output":{ + "shape":"Connection", + "documentation":"

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Creates a hosted connection on an interconnect.

\n

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.

" + }, + "AllocatePrivateVirtualInterface":{ + "name":"AllocatePrivateVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AllocatePrivateVirtualInterfaceRequest", + "documentation":"

Container for the parameters to the AllocatePrivateVirtualInterface operation.

" + }, + "output":{ + "shape":"VirtualInterface", + "documentation":"

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Provisions a private virtual interface to be owned by a different customer.

\n

The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.

\n

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

" + }, + "AllocatePublicVirtualInterface":{ + "name":"AllocatePublicVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AllocatePublicVirtualInterfaceRequest", + "documentation":"

Container for the parameters to the AllocatePublicVirtualInterface operation.

" + }, + "output":{ + "shape":"VirtualInterface", + "documentation":"

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Provisions a public virtual interface to be owned by a different customer.

\n

The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.

\n

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

" + }, + "ConfirmConnection":{ + "name":"ConfirmConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ConfirmConnectionRequest", + "documentation":"

Container for the parameters to the ConfirmConnection operation.

" + }, + "output":{ + "shape":"ConfirmConnectionResponse", + "documentation":"

The response received when ConfirmConnection is called.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Confirm the creation of a hosted connection on an interconnect.

\n

Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.

" + }, + "ConfirmPrivateVirtualInterface":{ + "name":"ConfirmPrivateVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ConfirmPrivateVirtualInterfaceRequest", + "documentation":"

Container for the parameters to the ConfirmPrivateVirtualInterface operation.

" + }, + "output":{ + "shape":"ConfirmPrivateVirtualInterfaceResponse", + "documentation":"

The response received when ConfirmPrivateVirtualInterface is called.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Accept ownership of a private virtual interface created by another customer.

\n

After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.

" + }, + "ConfirmPublicVirtualInterface":{ + "name":"ConfirmPublicVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ConfirmPublicVirtualInterfaceRequest", + "documentation":"

Container for the parameters to the ConfirmPublicVirtualInterface operation.

" + }, + "output":{ + "shape":"ConfirmPublicVirtualInterfaceResponse", + "documentation":"

The response received when ConfirmPublicVirtualInterface is called.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Accept ownership of a public virtual interface created by another customer.

\n

After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.

" + }, + "CreateConnection":{ + "name":"CreateConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateConnectionRequest", + "documentation":"

Container for the parameters to the CreateConnection operation.

" + }, + "output":{ + "shape":"Connection", + "documentation":"

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Creates a new connection between the customer network and a specific AWS Direct Connect location.

\n\n

A connection links your internal network to an AWS Direct Connect location over a standard 1\n gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your\n router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.

" + }, + "CreateInterconnect":{ + "name":"CreateInterconnect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateInterconnectRequest", + "documentation":"

Container for the parameters to the CreateInterconnect operation.

" + }, + "output":{ + "shape":"Interconnect", + "documentation":"

An interconnect is a connection that can host other connections.

\n

Like a standard AWS Direct Connect connection, an interconnect represents the physical\n connection between an AWS Direct Connect partner's network and a specific Direct Connect\n location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.

\n

The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.

\n

An interconnect is a connection which is capable of hosting other connections. The AWS\n Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service\n to tier 2 customers who do not have their own connections. Like a standard connection, an\n interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

\n

For each end customer, the AWS Direct Connect partner provisions a connection on their\n interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect\n to AWS resources by creating a virtual interface on their connection, using the VLAN assigned\n to them by the AWS Direct Connect partner.

" + }, + "CreatePrivateVirtualInterface":{ + "name":"CreatePrivateVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreatePrivateVirtualInterfaceRequest", + "documentation":"

Container for the parameters to the CreatePrivateVirtualInterface operation.

" + }, + "output":{ + "shape":"VirtualInterface", + "documentation":"

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS\n Direct Connect traffic. A private virtual interface supports sending traffic to a single\n virtual private cloud (VPC).

" + }, + "CreatePublicVirtualInterface":{ + "name":"CreatePublicVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreatePublicVirtualInterfaceRequest", + "documentation":"

Container for the parameters to the CreatePublicVirtualInterface operation.

" + }, + "output":{ + "shape":"VirtualInterface", + "documentation":"

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).

" + }, + "DeleteConnection":{ + "name":"DeleteConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteConnectionRequest", + "documentation":"

Container for the parameters to the DeleteConnection operation.

" + }, + "output":{ + "shape":"Connection", + "documentation":"

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Deletes the connection.

\n

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges.\n You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.

" + }, + "DeleteInterconnect":{ + "name":"DeleteInterconnect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteInterconnectRequest", + "documentation":"

Container for the parameters to the DeleteInterconnect operation.

" + }, + "output":{ + "shape":"DeleteInterconnectResponse", + "documentation":"

The response received when DeleteInterconnect is called.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Deletes the specified interconnect.

" + }, + "DeleteVirtualInterface":{ + "name":"DeleteVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteVirtualInterfaceRequest", + "documentation":"

Container for the parameters to the DeleteVirtualInterface operation.

" + }, + "output":{ + "shape":"DeleteVirtualInterfaceResponse", + "documentation":"

The response received when DeleteVirtualInterface is called.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Deletes a virtual interface.

" + }, + "DescribeConnections":{ + "name":"DescribeConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeConnectionsRequest", + "documentation":"

Container for the parameters to the DescribeConnections operation.

" + }, + "output":{ + "shape":"Connections", + "documentation":"

A structure containing a list of connections.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Displays all connections in this region.

\n

If a connection ID is provided, the call returns only that particular connection.

" + }, + "DescribeConnectionsOnInterconnect":{ + "name":"DescribeConnectionsOnInterconnect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeConnectionsOnInterconnectRequest", + "documentation":"

Container for the parameters to the DescribeConnectionsOnInterconnect operation.

" + }, + "output":{ + "shape":"Connections", + "documentation":"

A structure containing a list of connections.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Return a list of connections that have been provisioned on the given interconnect.

" + }, + "DescribeInterconnects":{ + "name":"DescribeInterconnects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeInterconnectsRequest", + "documentation":"

Container for the parameters to the DescribeInterconnects operation.

" + }, + "output":{ + "shape":"Interconnects", + "documentation":"

A structure containing a list of interconnects.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Returns a list of interconnects owned by the AWS account.

\n

If an interconnect ID is provided, it will only return this particular interconnect.

" + }, + "DescribeLocations":{ + "name":"DescribeLocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"Locations"}, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.

" + }, + "DescribeVirtualGateways":{ + "name":"DescribeVirtualGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"VirtualGateways", + "documentation":"

A structure containing a list of virtual private gateways.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Returns a list of virtual private gateways owned by the AWS account.

\n

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

" + }, + "DescribeVirtualInterfaces":{ + "name":"DescribeVirtualInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeVirtualInterfacesRequest", + "documentation":"

Container for the parameters to the DescribeVirtualInterfaces operation.

" + }, + "output":{ + "shape":"VirtualInterfaces", + "documentation":"

A structure containing a list of virtual interfaces.

" + }, + "errors":[ + { + "shape":"DirectConnectServerException", + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + { + "shape":"DirectConnectClientException", + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + } + ], + "documentation":"

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.

\n

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

\n

If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.

" + } + }, + "shapes":{ + "ASN":{ + "type":"integer", + "documentation":"

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

" + }, + "AllocateConnectionOnInterconnectRequest":{ + "type":"structure", + "required":[ + "bandwidth", + "connectionName", + "ownerAccount", + "interconnectId", + "vlan" + ], + "members":{ + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

Bandwidth of the connection.

\n

Example: \"500Mbps\"

\n

Default: None

" + }, + "connectionName":{ + "shape":"ConnectionName", + "documentation":"

Name of the provisioned connection.

\n

Example: \"500M Connection to AWS\"

\n

Default: None

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

Numeric account Id of the customer for whom the connection will be provisioned.

\n

Example: 123443215678

\n

Default: None

" + }, + "interconnectId":{ + "shape":"InterconnectId", + "documentation":"

ID of the interconnect on which the connection will be provisioned.

\n

Example: dxcon-456abc78

\n

Default: None

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The dedicated VLAN provisioned to the connection.

\n

Example: 101

\n

Default: None

" + } + }, + "documentation":"

Container for the parameters to the AllocateConnectionOnInterconnect operation.

" + }, + "AllocatePrivateVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "ownerAccount", + "newPrivateVirtualInterfaceAllocation" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The connection ID on which the private virtual interface is provisioned.

\n

Default: None

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The AWS account that will own the new private virtual interface.

\n

Default: None

" + }, + "newPrivateVirtualInterfaceAllocation":{ + "shape":"NewPrivateVirtualInterfaceAllocation", + "documentation":"

Detailed information for the private virtual interface to be provisioned.

\n

Default: None

" + } + }, + "documentation":"

Container for the parameters to the AllocatePrivateVirtualInterface operation.

" + }, + "AllocatePublicVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "ownerAccount", + "newPublicVirtualInterfaceAllocation" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The connection ID on which the public virtual interface is provisioned.

\n

Default: None

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The AWS account that will own the new public virtual interface.

\n

Default: None

" + }, + "newPublicVirtualInterfaceAllocation":{ + "shape":"NewPublicVirtualInterfaceAllocation", + "documentation":"

Detailed information for the public virtual interface to be provisioned.

\n

Default: None

" + } + }, + "documentation":"

Container for the parameters to the AllocatePublicVirtualInterface operation.

" + }, + "AmazonAddress":{ + "type":"string", + "documentation":"

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

" + }, + "BGPAuthKey":{ + "type":"string", + "documentation":"

Authentication key for BGP configuration.

\n

Example: asdf34example

" + }, + "Bandwidth":{ + "type":"string", + "documentation":"

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

" + }, + "CIDR":{"type":"string"}, + "ConfirmConnectionRequest":{ + "type":"structure", + "required":["connectionId"], + "members":{ + "connectionId":{"shape":"ConnectionId"} + }, + "documentation":"

Container for the parameters to the ConfirmConnection operation.

" + }, + "ConfirmConnectionResponse":{ + "type":"structure", + "members":{ + "connectionState":{"shape":"ConnectionState"} + }, + "documentation":"

The response received when ConfirmConnection is called.

" + }, + "ConfirmPrivateVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "virtualInterfaceId", + "virtualGatewayId" + ], + "members":{ + "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

ID of the virtual private gateway that will be attached to the virtual interface.

\n

A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

\n

Default: None

" + } + }, + "documentation":"

Container for the parameters to the ConfirmPrivateVirtualInterface operation.

" + }, + "ConfirmPrivateVirtualInterfaceResponse":{ + "type":"structure", + "members":{ + "virtualInterfaceState":{"shape":"VirtualInterfaceState"} + }, + "documentation":"

The response received when ConfirmPrivateVirtualInterface is called.

" + }, + "ConfirmPublicVirtualInterfaceRequest":{ + "type":"structure", + "required":["virtualInterfaceId"], + "members":{ + "virtualInterfaceId":{"shape":"VirtualInterfaceId"} + }, + "documentation":"

Container for the parameters to the ConfirmPublicVirtualInterface operation.

" + }, + "ConfirmPublicVirtualInterfaceResponse":{ + "type":"structure", + "members":{ + "virtualInterfaceState":{"shape":"VirtualInterfaceState"} + }, + "documentation":"

The response received when ConfirmPublicVirtualInterface is called.

" + }, + "Connection":{ + "type":"structure", + "members":{ + "ownerAccount":{"shape":"OwnerAccount"}, + "connectionId":{"shape":"ConnectionId"}, + "connectionName":{"shape":"ConnectionName"}, + "connectionState":{"shape":"ConnectionState"}, + "region":{"shape":"Region"}, + "location":{"shape":"LocationCode"}, + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

Bandwidth of the connection.

\n

Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

\n

Default: None

" + }, + "vlan":{"shape":"VLAN"}, + "partnerName":{"shape":"PartnerName"} + }, + "documentation":"

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

" + }, + "ConnectionId":{ + "type":"string", + "documentation":"

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

" + }, + "ConnectionList":{ + "type":"list", + "member":{"shape":"Connection"}, + "documentation":"

A list of connections.

" + }, + "ConnectionName":{ + "type":"string", + "documentation":"

The name of the connection.

\n

Example: \"My Connection to AWS\"

\n

Default: None

" + }, + "ConnectionState":{ + "type":"string", + "enum":[ + "ordering", + "requested", + "pending", + "available", + "down", + "deleting", + "deleted", + "rejected" + ], + "documentation":"State of the connection.\n " + }, + "Connections":{ + "type":"structure", + "members":{ + "connections":{ + "shape":"ConnectionList", + "documentation":"

A list of connections.

" + } + }, + "documentation":"

A structure containing a list of connections.

" + }, + "CreateConnectionRequest":{ + "type":"structure", + "required":[ + "location", + "bandwidth", + "connectionName" + ], + "members":{ + "location":{"shape":"LocationCode"}, + "bandwidth":{"shape":"Bandwidth"}, + "connectionName":{"shape":"ConnectionName"} + }, + "documentation":"

Container for the parameters to the CreateConnection operation.

" + }, + "CreateInterconnectRequest":{ + "type":"structure", + "required":[ + "interconnectName", + "bandwidth", + "location" + ], + "members":{ + "interconnectName":{ + "shape":"InterconnectName", + "documentation":"

The name of the interconnect.

\n

Example: \"1G Interconnect to AWS\"

\n

Default: None

" + }, + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

The port bandwidth

\n

Example: 1Gbps

\n

Default: None

\n

Available values: 1Gbps,10Gbps

" + }, + "location":{ + "shape":"LocationCode", + "documentation":"

Where the interconnect is located

\n

Example: EqSV5

\n

Default: None

" + } + }, + "documentation":"

Container for the parameters to the CreateInterconnect operation.

" + }, + "CreatePrivateVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "newPrivateVirtualInterface" + ], + "members":{ + "connectionId":{"shape":"ConnectionId"}, + "newPrivateVirtualInterface":{ + "shape":"NewPrivateVirtualInterface", + "documentation":"

Detailed information for the private virtual interface to be created.

\n

Default: None

" + } + }, + "documentation":"

Container for the parameters to the CreatePrivateVirtualInterface operation.

" + }, + "CreatePublicVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "newPublicVirtualInterface" + ], + "members":{ + "connectionId":{"shape":"ConnectionId"}, + "newPublicVirtualInterface":{ + "shape":"NewPublicVirtualInterface", + "documentation":"

Detailed information for the public virtual interface to be created.

\n

Default: None

" + } + }, + "documentation":"

Container for the parameters to the CreatePublicVirtualInterface operation.

" + }, + "CustomerAddress":{ + "type":"string", + "documentation":"

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

" + }, + "DeleteConnectionRequest":{ + "type":"structure", + "required":["connectionId"], + "members":{ + "connectionId":{"shape":"ConnectionId"} + }, + "documentation":"

Container for the parameters to the DeleteConnection operation.

" + }, + "DeleteInterconnectRequest":{ + "type":"structure", + "required":["interconnectId"], + "members":{ + "interconnectId":{"shape":"InterconnectId"} + }, + "documentation":"

Container for the parameters to the DeleteInterconnect operation.

" + }, + "DeleteInterconnectResponse":{ + "type":"structure", + "members":{ + "interconnectState":{"shape":"InterconnectState"} + }, + "documentation":"

The response received when DeleteInterconnect is called.

" + }, + "DeleteVirtualInterfaceRequest":{ + "type":"structure", + "required":["virtualInterfaceId"], + "members":{ + "virtualInterfaceId":{"shape":"VirtualInterfaceId"} + }, + "documentation":"

Container for the parameters to the DeleteVirtualInterface operation.

" + }, + "DeleteVirtualInterfaceResponse":{ + "type":"structure", + "members":{ + "virtualInterfaceState":{"shape":"VirtualInterfaceState"} + }, + "documentation":"

The response received when DeleteVirtualInterface is called.

" + }, + "DescribeConnectionsOnInterconnectRequest":{ + "type":"structure", + "required":["interconnectId"], + "members":{ + "interconnectId":{ + "shape":"InterconnectId", + "documentation":"

ID of the interconnect on which a list of connection is provisioned.

\n

Example: dxcon-abc123

\n

Default: None

" + } + }, + "documentation":"

Container for the parameters to the DescribeConnectionsOnInterconnect operation.

" + }, + "DescribeConnectionsRequest":{ + "type":"structure", + "members":{ + "connectionId":{"shape":"ConnectionId"} + }, + "documentation":"

Container for the parameters to the DescribeConnections operation.

" + }, + "DescribeInterconnectsRequest":{ + "type":"structure", + "members":{ + "interconnectId":{"shape":"InterconnectId"} + }, + "documentation":"

Container for the parameters to the DescribeInterconnects operation.

" + }, + "DescribeVirtualInterfacesRequest":{ + "type":"structure", + "members":{ + "connectionId":{"shape":"ConnectionId"}, + "virtualInterfaceId":{"shape":"VirtualInterfaceId"} + }, + "documentation":"

Container for the parameters to the DescribeVirtualInterfaces operation.

" + }, + "DirectConnectClientException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

" + }, + "DirectConnectServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

" + }, + "ErrorMessage":{"type":"string"}, + "Interconnect":{ + "type":"structure", + "members":{ + "interconnectId":{"shape":"InterconnectId"}, + "interconnectName":{"shape":"InterconnectName"}, + "interconnectState":{"shape":"InterconnectState"}, + "region":{"shape":"Region"}, + "location":{"shape":"LocationCode"}, + "bandwidth":{"shape":"Bandwidth"} + }, + "documentation":"

An interconnect is a connection that can host other connections.

\n

Like a standard AWS Direct Connect connection, an interconnect represents the physical\n connection between an AWS Direct Connect partner's network and a specific Direct Connect\n location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.

\n

The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.

" + }, + "InterconnectId":{ + "type":"string", + "documentation":"

The ID of the interconnect.

\n

Example: dxcon-abc123

" + }, + "InterconnectList":{ + "type":"list", + "member":{"shape":"Interconnect"}, + "documentation":"

A list of interconnects.

" + }, + "InterconnectName":{ + "type":"string", + "documentation":"

The name of the interconnect.

\n

Example: \"1G Interconnect to AWS\"

" + }, + "InterconnectState":{ + "type":"string", + "enum":[ + "requested", + "pending", + "available", + "down", + "deleting", + "deleted" + ], + "documentation":"State of the interconnect.\n " + }, + "Interconnects":{ + "type":"structure", + "members":{ + "interconnects":{ + "shape":"InterconnectList", + "documentation":"

A list of interconnects.

" + } + }, + "documentation":"

A structure containing a list of interconnects.

" + }, + "Location":{ + "type":"structure", + "members":{ + "locationCode":{ + "shape":"LocationCode", + "documentation":"

The code used to indicate the AWS Direct Connect location.

" + }, + "locationName":{ + "shape":"LocationName", + "documentation":"

The name of the AWS Direct Connect location. The name includes the colocation partner name\n and the physical site of the lit building.

" + } + }, + "documentation":"

An AWS Direct Connect location where connections and interconnects can be requested.

" + }, + "LocationCode":{ + "type":"string", + "documentation":"

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

" + }, + "LocationList":{ + "type":"list", + "member":{"shape":"Location"} + }, + "LocationName":{"type":"string"}, + "Locations":{ + "type":"structure", + "members":{ + "locations":{"shape":"LocationList"} + } + }, + "NewPrivateVirtualInterface":{ + "type":"structure", + "required":[ + "virtualInterfaceName", + "vlan", + "asn", + "virtualGatewayId" + ], + "members":{ + "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, + "vlan":{"shape":"VLAN"}, + "asn":{"shape":"ASN"}, + "authKey":{"shape":"BGPAuthKey"}, + "amazonAddress":{"shape":"AmazonAddress"}, + "customerAddress":{"shape":"CustomerAddress"}, + "virtualGatewayId":{"shape":"VirtualGatewayId"} + }, + "documentation":"

A structure containing information about a new private virtual interface.

" + }, + "NewPrivateVirtualInterfaceAllocation":{ + "type":"structure", + "required":[ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members":{ + "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, + "vlan":{"shape":"VLAN"}, + "asn":{"shape":"ASN"}, + "authKey":{"shape":"BGPAuthKey"}, + "amazonAddress":{"shape":"AmazonAddress"}, + "customerAddress":{"shape":"CustomerAddress"} + }, + "documentation":"

A structure containing information about a private virtual interface that will be provisioned on a connection.

" + }, + "NewPublicVirtualInterface":{ + "type":"structure", + "required":[ + "virtualInterfaceName", + "vlan", + "asn", + "amazonAddress", + "customerAddress", + "routeFilterPrefixes" + ], + "members":{ + "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, + "vlan":{"shape":"VLAN"}, + "asn":{"shape":"ASN"}, + "authKey":{"shape":"BGPAuthKey"}, + "amazonAddress":{"shape":"AmazonAddress"}, + "customerAddress":{"shape":"CustomerAddress"}, + "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"} + }, + "documentation":"

A structure containing information about a new public virtual interface.

" + }, + "NewPublicVirtualInterfaceAllocation":{ + "type":"structure", + "required":[ + "virtualInterfaceName", + "vlan", + "asn", + "amazonAddress", + "customerAddress", + "routeFilterPrefixes" + ], + "members":{ + "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, + "vlan":{"shape":"VLAN"}, + "asn":{"shape":"ASN"}, + "authKey":{"shape":"BGPAuthKey"}, + "amazonAddress":{"shape":"AmazonAddress"}, + "customerAddress":{"shape":"CustomerAddress"}, + "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"} + }, + "documentation":"

A structure containing information about a public virtual interface that will be provisioned on a connection.

" + }, + "OwnerAccount":{"type":"string"}, + "PartnerName":{"type":"string"}, + "Region":{ + "type":"string", + "documentation":"

The AWS region where the connection is located.

\n

Example: us-east-1

\n

Default: None

" + }, + "RouteFilterPrefix":{ + "type":"structure", + "members":{ + "cidr":{ + "shape":"CIDR", + "documentation":"

CIDR notation for the advertised route. Multiple routes are separated by commas.

\n

Example: 10.10.10.0/24,10.10.11.0/24

" + } + }, + "documentation":"

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

" + }, + "RouteFilterPrefixList":{ + "type":"list", + "member":{"shape":"RouteFilterPrefix"}, + "documentation":"

A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

" + }, + "RouterConfig":{"type":"string"}, + "VLAN":{ + "type":"integer", + "documentation":"

The VLAN ID.

\n

Example: 101

" + }, + "VirtualGateway":{ + "type":"structure", + "members":{ + "virtualGatewayId":{"shape":"VirtualGatewayId"}, + "virtualGatewayState":{"shape":"VirtualGatewayState"} + }, + "documentation":"

You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway.

\n

Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC)\n console or the Amazon\n EC2 CreateVpnGateway action.

" + }, + "VirtualGatewayId":{ + "type":"string", + "documentation":"

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

\n

Example: vgw-123er56

" + }, + "VirtualGatewayList":{ + "type":"list", + "member":{"shape":"VirtualGateway"}, + "documentation":"

A list of virtual private gateways.

" + }, + "VirtualGatewayState":{ + "type":"string", + "documentation":"State of the virtual private gateway.\n " + }, + "VirtualGateways":{ + "type":"structure", + "members":{ + "virtualGateways":{ + "shape":"VirtualGatewayList", + "documentation":"

A list of virtual private gateways.

" + } + }, + "documentation":"

A structure containing a list of virtual private gateways.

" + }, + "VirtualInterface":{ + "type":"structure", + "members":{ + "ownerAccount":{"shape":"OwnerAccount"}, + "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, + "location":{"shape":"LocationCode"}, + "connectionId":{"shape":"ConnectionId"}, + "virtualInterfaceType":{"shape":"VirtualInterfaceType"}, + "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, + "vlan":{"shape":"VLAN"}, + "asn":{"shape":"ASN"}, + "authKey":{"shape":"BGPAuthKey"}, + "amazonAddress":{"shape":"AmazonAddress"}, + "customerAddress":{"shape":"CustomerAddress"}, + "virtualInterfaceState":{"shape":"VirtualInterfaceState"}, + "customerRouterConfig":{ + "shape":"RouterConfig", + "documentation":"

Information for generating the customer router configuration.

" + }, + "virtualGatewayId":{"shape":"VirtualGatewayId"}, + "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"} + }, + "documentation":"

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

" + }, + "VirtualInterfaceId":{ + "type":"string", + "documentation":"

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

" + }, + "VirtualInterfaceList":{ + "type":"list", + "member":{"shape":"VirtualInterface"}, + "documentation":"

A list of virtual interfaces.

" + }, + "VirtualInterfaceName":{ + "type":"string", + "documentation":"

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

" + }, + "VirtualInterfaceState":{ + "type":"string", + "enum":[ + "confirming", + "verifying", + "pending", + "available", + "deleting", + "deleted", + "rejected" + ], + "documentation":"State of the virtual interface.\n " + }, + "VirtualInterfaceType":{ + "type":"string", + "documentation":"

The type of virtual interface.

\n

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

" + }, + "VirtualInterfaces":{ + "type":"structure", + "members":{ + "virtualInterfaces":{ + "shape":"VirtualInterfaceList", + "documentation":"

A list of virtual interfaces.

" + } + }, + "documentation":"

A structure containing a list of virtual interfaces.

" + } + } +} diff --git a/apis/directconnect-2012-10-25.paginators.json b/apis/directconnect-2012-10-25.paginators.json new file mode 100644 index 0000000000..cc93bedd41 --- /dev/null +++ b/apis/directconnect-2012-10-25.paginators.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeConnections": { + "result_key": "connections" + }, + "DescribeConnectionsOnInterconnect": { + "result_key": "connections" + }, + "DescribeInterconnects": { + "result_key": "interconnects" + }, + "DescribeLocations": { + "result_key": "locations" + }, + "DescribeVirtualGateways": { + "result_key": "virtualGateways" + }, + "DescribeVirtualInterfaces": { + "result_key": "virtualInterfaces" + } + } +} diff --git a/apis/dynamodb-2011-12-05.api.json b/apis/dynamodb-2011-12-05.api.json new file mode 100644 index 0000000000..16000c181c --- /dev/null +++ b/apis/dynamodb-2011-12-05.api.json @@ -0,0 +1,662 @@ +{ + "metadata": { + "apiVersion": "2011-12-05", + "endpointPrefix": "dynamodb", + "jsonVersion": "1.0", + "serviceAbbreviation": "DynamoDB", + "serviceFullName": "Amazon DynamoDB", + "signatureVersion": "v4", + "targetPrefix": "DynamoDB_20111205", + "protocol": "json" + }, + "operations": { + "BatchGetItem": { + "input": { + "type": "structure", + "required": [ + "RequestItems" + ], + "members": { + "RequestItems": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Items": { + "shape": "Sk" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "UnprocessedKeys": { + "shape": "S2" + } + } + } + }, + "BatchWriteItem": { + "input": { + "type": "structure", + "required": [ + "RequestItems" + ], + "members": { + "RequestItems": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "UnprocessedItems": { + "shape": "So" + } + } + } + }, + "CreateTable": { + "input": { + "type": "structure", + "required": [ + "TableName", + "KeySchema", + "ProvisionedThroughput" + ], + "members": { + "TableName": {}, + "KeySchema": { + "shape": "Sy" + }, + "ProvisionedThroughput": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S15" + } + } + } + }, + "DeleteItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "Expected": { + "shape": "S1b" + }, + "ReturnValues": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Sl" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "DeleteTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S15" + } + } + } + }, + "DescribeTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Table": { + "shape": "S15" + } + } + } + }, + "GetItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "AttributesToGet": { + "shape": "Se" + }, + "ConsistentRead": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Item": { + "shape": "Sl" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "ListTables": { + "input": { + "type": "structure", + "members": { + "ExclusiveStartTableName": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableNames": { + "type": "list", + "member": {} + }, + "LastEvaluatedTableName": {} + } + } + }, + "PutItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Item" + ], + "members": { + "TableName": {}, + "Item": { + "shape": "Ss" + }, + "Expected": { + "shape": "S1b" + }, + "ReturnValues": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Sl" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "Query": { + "input": { + "type": "structure", + "required": [ + "TableName", + "HashKeyValue" + ], + "members": { + "TableName": {}, + "AttributesToGet": { + "shape": "Se" + }, + "Limit": { + "type": "integer" + }, + "ConsistentRead": { + "type": "boolean" + }, + "Count": { + "type": "boolean" + }, + "HashKeyValue": { + "shape": "S7" + }, + "RangeKeyCondition": { + "shape": "S1u" + }, + "ScanIndexForward": { + "type": "boolean" + }, + "ExclusiveStartKey": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "shape": "Sk" + }, + "Count": { + "type": "integer" + }, + "LastEvaluatedKey": { + "shape": "S6" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "Scan": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {}, + "AttributesToGet": { + "shape": "Se" + }, + "Limit": { + "type": "integer" + }, + "Count": { + "type": "boolean" + }, + "ScanFilter": { + "type": "map", + "key": {}, + "value": { + "shape": "S1u" + } + }, + "ExclusiveStartKey": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "shape": "Sk" + }, + "Count": { + "type": "integer" + }, + "ScannedCount": { + "type": "integer" + }, + "LastEvaluatedKey": { + "shape": "S6" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "UpdateItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key", + "AttributeUpdates" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "AttributeUpdates": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Value": { + "shape": "S7" + }, + "Action": {} + } + } + }, + "Expected": { + "shape": "S1b" + }, + "ReturnValues": {} + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Sl" + }, + "ConsumedCapacityUnits": { + "type": "double" + } + } + } + }, + "UpdateTable": { + "input": { + "type": "structure", + "required": [ + "TableName", + "ProvisionedThroughput" + ], + "members": { + "TableName": {}, + "ProvisionedThroughput": { + "shape": "S12" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S15" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "Keys" + ], + "members": { + "Keys": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "AttributesToGet": { + "shape": "Se" + }, + "ConsistentRead": { + "type": "boolean" + } + } + } + }, + "S6": { + "type": "structure", + "required": [ + "HashKeyElement" + ], + "members": { + "HashKeyElement": { + "shape": "S7" + }, + "RangeKeyElement": { + "shape": "S7" + } + } + }, + "S7": { + "type": "structure", + "members": { + "S": {}, + "N": {}, + "B": { + "type": "blob" + }, + "SS": { + "type": "list", + "member": {} + }, + "NS": { + "type": "list", + "member": {} + }, + "BS": { + "type": "list", + "member": { + "type": "blob" + } + } + } + }, + "Se": { + "type": "list", + "member": {} + }, + "Sk": { + "type": "list", + "member": { + "shape": "Sl" + } + }, + "Sl": { + "type": "map", + "key": {}, + "value": { + "shape": "S7" + } + }, + "So": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PutRequest": { + "type": "structure", + "required": [ + "Item" + ], + "members": { + "Item": { + "shape": "Ss" + } + } + }, + "DeleteRequest": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": { + "shape": "S6" + } + } + } + } + } + } + }, + "Ss": { + "type": "map", + "key": {}, + "value": { + "shape": "S7" + } + }, + "Sy": { + "type": "structure", + "required": [ + "HashKeyElement" + ], + "members": { + "HashKeyElement": { + "shape": "Sz" + }, + "RangeKeyElement": { + "shape": "Sz" + } + } + }, + "Sz": { + "type": "structure", + "required": [ + "AttributeName", + "AttributeType" + ], + "members": { + "AttributeName": {}, + "AttributeType": {} + } + }, + "S12": { + "type": "structure", + "required": [ + "ReadCapacityUnits", + "WriteCapacityUnits" + ], + "members": { + "ReadCapacityUnits": { + "type": "long" + }, + "WriteCapacityUnits": { + "type": "long" + } + } + }, + "S15": { + "type": "structure", + "members": { + "TableName": {}, + "KeySchema": { + "shape": "Sy" + }, + "TableStatus": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "ProvisionedThroughput": { + "type": "structure", + "members": { + "LastIncreaseDateTime": { + "type": "timestamp" + }, + "LastDecreaseDateTime": { + "type": "timestamp" + }, + "NumberOfDecreasesToday": { + "type": "long" + }, + "ReadCapacityUnits": { + "type": "long" + }, + "WriteCapacityUnits": { + "type": "long" + } + } + }, + "TableSizeBytes": { + "type": "long" + }, + "ItemCount": { + "type": "long" + } + } + }, + "S1b": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Value": { + "shape": "S7" + }, + "Exists": { + "type": "boolean" + } + } + } + }, + "S1u": { + "type": "structure", + "required": [ + "ComparisonOperator" + ], + "members": { + "AttributeValueList": { + "type": "list", + "member": { + "shape": "S7" + } + }, + "ComparisonOperator": {} + } + } + } +} \ No newline at end of file diff --git a/apis/dynamodb-2011-12-05.full.json b/apis/dynamodb-2011-12-05.full.json new file mode 100644 index 0000000000..836dc833dd --- /dev/null +++ b/apis/dynamodb-2011-12-05.full.json @@ -0,0 +1,1208 @@ +{ + "metadata":{ + "apiVersion":"2011-12-05", + "endpointPrefix":"dynamodb", + "jsonVersion":"1.0", + "serviceAbbreviation":"DynamoDB", + "serviceFullName":"Amazon DynamoDB", + "signatureVersion":"v4", + "targetPrefix":"DynamoDB_20111205", + "protocol":"json" + }, + "documentation":"

Amazon DynamoDB is a fast, highly scalable, highly available, cost-effective non-relational database service.

Amazon DynamoDB removes traditional scalability limitations on data storage while maintaining low latency and predictable performance.

", + "operations":{ + "BatchGetItem":{ + "name":"BatchGetItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetItemInput"}, + "output":{"shape":"BatchGetItemOutput"}, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Retrieves the attributes for multiple items from multiple tables using their primary keys.

The maximum number of item attributes that can be retrieved for a single operation is 100. Also, the number of items retrieved is constrained by a 1 MB the size limit. If the response size limit is exceeded or a partial result is returned due to an internal processing failure, Amazon DynamoDB returns an UnprocessedKeys value so you can retry the operation starting with the next item to get.

Amazon DynamoDB automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to retrieve 100 items, but each individual item is 50k in size, the system returns 20 items and an appropriate UnprocessedKeys value so you can get the next page of results. If necessary, your application needs its own logic to assemble the pages of results into one set.

" + }, + "BatchWriteItem":{ + "name":"BatchWriteItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchWriteItemInput"}, + "output":{ + "shape":"BatchWriteItemOutput", + "documentation":"

A container for BatchWriteItem response

" + }, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Allows to execute a batch of Put and/or Delete Requests for many tables in a single call. A total of 25 requests are allowed.

There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.

" + }, + "CreateTable":{ + "name":"CreateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTableInput"}, + "output":{"shape":"CreateTableOutput"}, + "errors":[ + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Adds a new table to your account.

The table name must be unique among those associated with the AWS Account issuing the request, and the AWS Region that receives the request (e.g. us-east-1).

The CreateTable operation triggers an asynchronous workflow to begin creating the table. Amazon DynamoDB immediately returns the state of the table (CREATING) until the table is in the ACTIVE state. Once the table is in the ACTIVE state, you can perform data plane operations.

" + }, + "DeleteItem":{ + "name":"DeleteItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteItemInput"}, + "output":{"shape":"DeleteItemOutput"}, + "errors":[ + { + "shape":"ConditionalCheckFailedException", + "exception":true, + "documentation":"

This exception is thrown when an expected value does not match what was found in the system.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Deletes a single item in a table by primary key.

You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

" + }, + "DeleteTable":{ + "name":"DeleteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTableInput"}, + "output":{"shape":"DeleteTableOutput"}, + "errors":[ + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Deletes a table and all of its items.

If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states then Amazon DynamoDB returns a ResourceInUseException. If the specified table does not exist, Amazon DynamoDB returns a ResourceNotFoundException.

" + }, + "DescribeTable":{ + "name":"DescribeTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTableInput"}, + "output":{"shape":"DescribeTableOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Retrieves information about the table, including the current status of the table, the primary key schema and when the table was created.

If the table does not exist, Amazon DynamoDB returns a ResourceNotFoundException.

" + }, + "GetItem":{ + "name":"GetItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetItemInput"}, + "output":{"shape":"GetItemOutput"}, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Retrieves a set of Attributes for an item that matches the primary key.

The GetItem operation provides an eventually-consistent read by default. If eventually-consistent reads are not acceptable for your application, use ConsistentRead. Although this operation might take longer than a standard read, it always returns the last updated value.

" + }, + "ListTables":{ + "name":"ListTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTablesInput"}, + "output":{"shape":"ListTablesOutput"}, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. us-east-1).

" + }, + "PutItem":{ + "name":"PutItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutItemInput"}, + "output":{"shape":"PutItemOutput"}, + "errors":[ + { + "shape":"ConditionalCheckFailedException", + "exception":true, + "documentation":"

This exception is thrown when an expected value does not match what was found in the system.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Creates a new item, or replaces an old item with a new item (including all the attributes).

If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.

" + }, + "Query":{ + "name":"Query", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"QueryInput"}, + "output":{"shape":"QueryOutput"}, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Gets the values of one or more items and its attributes by primary key (composite primary key, only).

Narrow the scope of the query using comparison operators on the RangeKeyValue of the composite key. Use the ScanIndexForward parameter to get results in forward or reverse order by range key.

" + }, + "Scan":{ + "name":"Scan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScanInput"}, + "output":{"shape":"ScanOutput"}, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Retrieves one or more items and its attributes by performing a full scan of a table.

Provide a ScanFilter to get more specific results.

" + }, + "UpdateItem":{ + "name":"UpdateItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateItemInput"}, + "output":{"shape":"UpdateItemOutput"}, + "errors":[ + { + "shape":"ConditionalCheckFailedException", + "exception":true, + "documentation":"

This exception is thrown when an expected value does not match what was found in the system.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Edits an existing item's attributes.

You can perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

" + }, + "UpdateTable":{ + "name":"UpdateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTableInput"}, + "output":{"shape":"UpdateTableOutput"}, + "errors":[ + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + } + ], + "documentation":"

Updates the provisioned throughput for the given table.

Setting the throughput for a table helps you manage performance and is part of the Provisioned Throughput feature of Amazon DynamoDB.

" + } + }, + "shapes":{ + "AttributeAction":{ + "type":"string", + "enum":[ + "ADD", + "PUT", + "DELETE" + ], + "documentation":"

The type of action for an item update operation. Only use the add action for numbers or sets; the specified value is added to the existing value. If a set of values is specified, the values are added to the existing set. Adds the specified attribute. If the attribute exists, it is replaced by the new value. If no value is specified, this removes the attribute and its value. If a set of values is specified, then the values in the specified set are removed from the old set.

" + }, + "AttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AttributeName":{ + "type":"string", + "max":65535 + }, + "AttributeNameList":{ + "type":"list", + "member":{"shape":"AttributeName"}, + "min":1, + "documentation":"

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

" + }, + "AttributeUpdates":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValueUpdate"}, + "documentation":"

Map of attribute name to the new value and action for the update. The attribute names specify the attributes to modify, and cannot contain any primary key attributes.

" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "S":{ + "shape":"StringAttributeValue", + "documentation":"

Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

" + }, + "N":{ + "shape":"NumberAttributeValue", + "documentation":"

Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

" + }, + "B":{ + "shape":"BinaryAttributeValue", + "documentation":"

Binary attributes are sequences of unsigned bytes.

" + }, + "SS":{ + "shape":"StringSetAttributeValue", + "documentation":"

A set of strings.

" + }, + "NS":{ + "shape":"NumberSetAttributeValue", + "documentation":"

A set of numbers.

" + }, + "BS":{ + "shape":"BinarySetAttributeValue", + "documentation":"

A set of binary attributes.

" + } + }, + "documentation":"

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

" + }, + "AttributeValueList":{ + "type":"list", + "member":{"shape":"AttributeValue"}, + "documentation":"

A list of attribute values to be used with a comparison operator for a scan or query operation. For comparisons that require more than one value, such as a BETWEEN comparison, the AttributeValueList contains two attribute values and the comparison operator.

" + }, + "AttributeValueUpdate":{ + "type":"structure", + "members":{ + "Value":{"shape":"AttributeValue"}, + "Action":{"shape":"AttributeAction"} + }, + "documentation":"

Specifies the attribute to update and how to perform the update. Possible values: PUT (default), ADD or DELETE.

" + }, + "BatchGetItemInput":{ + "type":"structure", + "required":["RequestItems"], + "members":{ + "RequestItems":{"shape":"BatchGetRequestMap"} + } + }, + "BatchGetItemOutput":{ + "type":"structure", + "members":{ + "Responses":{"shape":"BatchGetResponseMap"}, + "UnprocessedKeys":{ + "shape":"BatchGetRequestMap", + "documentation":"

Contains a map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. The UnprocessedKeys value is in the same form as a RequestItems parameter (so the value can be provided directly to a subsequent BatchGetItem operation). For more information, see the above RequestItems parameter.

" + } + } + }, + "BatchGetRequestMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"KeysAndAttributes"}, + "min":1, + "max":100, + "documentation":"

A map of the table name and corresponding items to get by primary key. While requesting items, each table name can be invoked only once per operation.

" + }, + "BatchGetResponseMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"BatchResponse"}, + "documentation":"

Table names and the respective item attributes from the tables.

" + }, + "BatchResponse":{ + "type":"structure", + "members":{ + "Items":{"shape":"ItemList"}, + "ConsumedCapacityUnits":{"shape":"ConsumedCapacityUnits"} + }, + "documentation":"

The item attributes from a response in a specific table, along with the read resources consumed on the table during the request.

" + }, + "BatchWriteItemInput":{ + "type":"structure", + "required":["RequestItems"], + "members":{ + "RequestItems":{ + "shape":"BatchWriteItemRequestMap", + "documentation":"

A map of table name to list-of-write-requests. Used as input to the BatchWriteItem API call

" + } + } + }, + "BatchWriteItemOutput":{ + "type":"structure", + "members":{ + "Responses":{ + "shape":"BatchWriteResponseMap", + "documentation":"

The response object as a result of BatchWriteItem call. This is essentially a map of table name to ConsumedCapacityUnits.

" + }, + "UnprocessedItems":{ + "shape":"BatchWriteItemRequestMap", + "documentation":"

The Items which we could not successfully process in a BatchWriteItem call is returned as UnprocessedItems

" + } + }, + "documentation":"

A container for BatchWriteItem response

" + }, + "BatchWriteItemRequestMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"WriteRequests"}, + "min":1, + "max":25, + "documentation":"

A map of table name to list-of-write-requests.

Key: The table name corresponding to the list of requests

Value: Essentially a list of request items. Each request item could contain either a PutRequest or DeleteRequest. Never both.

" + }, + "BatchWriteResponse":{ + "type":"structure", + "members":{ + "ConsumedCapacityUnits":{"shape":"ConsumedCapacityUnits"} + } + }, + "BatchWriteResponseMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"BatchWriteResponse"} + }, + "BinaryAttributeValue":{"type":"blob"}, + "BinarySetAttributeValue":{ + "type":"list", + "member":{"shape":"BinaryAttributeValue"} + }, + "BooleanObject":{"type":"boolean"}, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "NE", + "IN", + "LE", + "LT", + "GE", + "GT", + "BETWEEN", + "NOT_NULL", + "NULL", + "CONTAINS", + "NOT_CONTAINS", + "BEGINS_WITH" + ], + "documentation":"

A comparison operator is an enumeration of several operations:

Scan operations support all available comparison operators.

Query operations support a subset of the available comparison operators: EQ, LE, LT, GE, GT, BETWEEN, and BEGINS_WITH.

" + }, + "Condition":{ + "type":"structure", + "required":["ComparisonOperator"], + "members":{ + "AttributeValueList":{"shape":"AttributeValueList"}, + "ComparisonOperator":{"shape":"ComparisonOperator"} + } + }, + "ConditionalCheckFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

This exception is thrown when an expected value does not match what was found in the system.

" + }, + "ConsistentRead":{ + "type":"boolean", + "documentation":"

If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.

" + }, + "ConsumedCapacityUnits":{ + "type":"double", + "documentation":"

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

" + }, + "CreateTableInput":{ + "type":"structure", + "required":[ + "TableName", + "KeySchema", + "ProvisionedThroughput" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table you want to create. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + }, + "KeySchema":{"shape":"KeySchema"}, + "ProvisionedThroughput":{"shape":"ProvisionedThroughput"} + } + }, + "CreateTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{"shape":"TableDescription"} + } + }, + "Date":{"type":"timestamp"}, + "DeleteItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table in which you want to delete an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + }, + "Key":{"shape":"Key"}, + "Expected":{"shape":"ExpectedAttributeMap"}, + "ReturnValues":{"shape":"ReturnValue"} + } + }, + "DeleteItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

If the ReturnValues parameter is provided as ALL_OLD in the request, Amazon DynamoDB returns an array of attribute name-value pairs (essentially, the deleted item). Otherwise, the response contains an empty set.

" + }, + "ConsumedCapacityUnits":{"shape":"ConsumedCapacityUnits"} + } + }, + "DeleteRequest":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The item's key to be delete

" + } + }, + "documentation":"

A container for a Delete BatchWrite request

" + }, + "DeleteTableInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table you want to delete. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + } + } + }, + "DeleteTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{"shape":"TableDescription"} + } + }, + "DescribeTableInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table you want to describe. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + } + } + }, + "DescribeTableOutput":{ + "type":"structure", + "members":{ + "Table":{"shape":"TableDescription"} + } + }, + "ErrorMessage":{"type":"string"}, + "ExpectedAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"ExpectedAttributeValue"}, + "documentation":"

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

" + }, + "ExpectedAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"AttributeValue", + "documentation":"

Specify whether or not a value already exists and has a specific content for the attribute name-value pair.

" + }, + "Exists":{ + "shape":"BooleanObject", + "documentation":"

Specify whether or not a value already exists for the attribute name-value pair.

" + } + }, + "documentation":"

Allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

" + }, + "FilterConditionMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Condition"} + }, + "GetItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table in which you want to get an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + }, + "Key":{"shape":"Key"}, + "AttributesToGet":{"shape":"AttributeNameList"}, + "ConsistentRead":{"shape":"ConsistentRead"} + } + }, + "GetItemOutput":{ + "type":"structure", + "members":{ + "Item":{ + "shape":"AttributeMap", + "documentation":"

Contains the requested attributes.

" + }, + "ConsumedCapacityUnits":{"shape":"ConsumedCapacityUnits"} + } + }, + "Integer":{"type":"integer"}, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "fault":true, + "documentation":"

This exception is thrown when the service has a problem when trying to process the request.

" + }, + "ItemList":{ + "type":"list", + "member":{"shape":"AttributeMap"} + }, + "Key":{ + "type":"structure", + "required":["HashKeyElement"], + "members":{ + "HashKeyElement":{ + "shape":"AttributeValue", + "documentation":"

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

" + }, + "RangeKeyElement":{ + "shape":"AttributeValue", + "documentation":"

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

" + } + }, + "documentation":"

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

" + }, + "KeyList":{ + "type":"list", + "member":{"shape":"Key"}, + "min":1, + "max":100 + }, + "KeySchema":{ + "type":"structure", + "required":["HashKeyElement"], + "members":{ + "HashKeyElement":{ + "shape":"KeySchemaElement", + "documentation":"

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

" + }, + "RangeKeyElement":{ + "shape":"KeySchemaElement", + "documentation":"

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

" + } + }, + "documentation":"

The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a HashKeyElement. A composite hash-and-range primary key contains two attribute values: a HashKeyElement and a RangeKeyElement.

" + }, + "KeySchemaAttributeName":{ + "type":"string", + "min":1, + "max":255 + }, + "KeySchemaElement":{ + "type":"structure", + "required":[ + "AttributeName", + "AttributeType" + ], + "members":{ + "AttributeName":{ + "shape":"KeySchemaAttributeName", + "documentation":"

The AttributeName of the KeySchemaElement.

" + }, + "AttributeType":{ + "shape":"ScalarAttributeType", + "documentation":"

The AttributeType of the KeySchemaElement which can be a String or a Number.

" + } + }, + "documentation":"

KeySchemaElement is the primary key (hash or hash-and-range) structure for the table.

" + }, + "KeysAndAttributes":{ + "type":"structure", + "required":["Keys"], + "members":{ + "Keys":{"shape":"KeyList"}, + "AttributesToGet":{"shape":"AttributeNameList"}, + "ConsistentRead":{"shape":"ConsistentRead"} + } + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.

" + }, + "ListTablesInput":{ + "type":"structure", + "members":{ + "ExclusiveStartTableName":{ + "shape":"TableName", + "documentation":"

The name of the table that starts the list. If you already ran a ListTables operation and received a LastEvaluatedTableName value in the response, use that value here to continue the list.

" + }, + "Limit":{"shape":"ListTablesInputLimit"} + } + }, + "ListTablesInputLimit":{ + "type":"integer", + "min":1, + "max":100, + "documentation":"

A number of maximum table names to return.

" + }, + "ListTablesOutput":{ + "type":"structure", + "members":{ + "TableNames":{"shape":"TableNameList"}, + "LastEvaluatedTableName":{ + "shape":"TableName", + "documentation":"

The name of the last table in the current list. Use this value as the ExclusiveStartTableName in a new request to continue the list until all the table names are returned. If this value is null, all table names have been returned.

" + } + } + }, + "Long":{"type":"long"}, + "NumberAttributeValue":{"type":"string"}, + "NumberSetAttributeValue":{ + "type":"list", + "member":{"shape":"NumberAttributeValue"} + }, + "PositiveIntegerObject":{ + "type":"integer", + "min":1 + }, + "PositiveLongObject":{ + "type":"long", + "min":1 + }, + "ProvisionedThroughput":{ + "type":"structure", + "required":[ + "ReadCapacityUnits", + "WriteCapacityUnits" + ], + "members":{ + "ReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

ReadCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the ReadCapacityUnits. Eventually-consistent reads only require half the ReadCapacityUnits of stirctly consistent reads.

" + }, + "WriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

WriteCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the WriteCapacityUnits.

" + } + }, + "documentation":"

Provisioned throughput reserves the required read and write resources for your table in terms of ReadCapacityUnits and WriteCapacityUnits. Values for provisioned throughput depend upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value. For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent reads.

" + }, + "ProvisionedThroughputDescription":{ + "type":"structure", + "members":{ + "LastIncreaseDateTime":{"shape":"Date"}, + "LastDecreaseDateTime":{"shape":"Date"}, + "NumberOfDecreasesToday":{"shape":"PositiveLongObject"}, + "ReadCapacityUnits":{"shape":"PositiveLongObject"}, + "WriteCapacityUnits":{"shape":"PositiveLongObject"} + } + }, + "ProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

This exception is thrown when the level of provisioned throughput defined for the table is exceeded.

" + }, + "PutItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Item" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + }, + "Item":{"shape":"PutItemInputAttributeMap"}, + "Expected":{"shape":"ExpectedAttributeMap"}, + "ReturnValues":{"shape":"ReturnValue"} + } + }, + "PutItemInputAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"}, + "documentation":"

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

" + }, + "PutItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

Attribute values before the put operation, but only if the ReturnValues parameter is specified as ALL_OLD in the request.

" + }, + "ConsumedCapacityUnits":{"shape":"ConsumedCapacityUnits"} + } + }, + "PutRequest":{ + "type":"structure", + "required":["Item"], + "members":{ + "Item":{ + "shape":"PutItemInputAttributeMap", + "documentation":"

The item to put

" + } + }, + "documentation":"

A container for a Put BatchWrite request

" + }, + "QueryInput":{ + "type":"structure", + "required":[ + "TableName", + "HashKeyValue" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table in which you want to query. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + }, + "AttributesToGet":{"shape":"AttributeNameList"}, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of items to return. If Amazon DynamoDB hits this limit while querying the table, it stops the query and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the query. Also, if the result set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops the query and returns the matching values, and a LastEvaluatedKey to apply in a subsequent operation to continue the query.

" + }, + "ConsistentRead":{"shape":"ConsistentRead"}, + "Count":{ + "shape":"BooleanObject", + "documentation":"

If set to true, Amazon DynamoDB returns a total number of items that match the query parameters, instead of a list of the matching items and their attributes. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.

" + }, + "HashKeyValue":{ + "shape":"AttributeValue", + "documentation":"

Attribute value of the hash component of the composite primary key.

" + }, + "RangeKeyCondition":{ + "shape":"Condition", + "documentation":"

A container for the attribute values and comparison operators to use for the query.

" + }, + "ScanIndexForward":{ + "shape":"BooleanObject", + "documentation":"

Specifies forward or backward traversal of the index. Amazon DynamoDB returns results reflecting the requested order, determined by the range key. The default value is true (forward).

" + }, + "ExclusiveStartKey":{ + "shape":"Key", + "documentation":"

Primary key of the item from which to continue an earlier query. An earlier query might provide this value as the LastEvaluatedKey if that query operation was interrupted before completing the query; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new query request to continue the operation from that point.

" + } + } + }, + "QueryOutput":{ + "type":"structure", + "members":{ + "Items":{"shape":"ItemList"}, + "Count":{ + "shape":"Integer", + "documentation":"

Number of items in the response.

" + }, + "LastEvaluatedKey":{ + "shape":"Key", + "documentation":"

Primary key of the item where the query operation stopped, inclusive of the previous result set. Use this value to start a new operation excluding this value in the new request. The LastEvaluatedKey is null when the entire query result set is complete (i.e. the operation processed the \"last page\").

" + }, + "ConsumedCapacityUnits":{"shape":"ConsumedCapacityUnits"} + } + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

This exception is thrown when the resource which is being attempted to be changed is in use.

" + }, + "ReturnValue":{ + "type":"string", + "enum":[ + "NONE", + "ALL_OLD", + "UPDATED_OLD", + "ALL_NEW", + "UPDATED_NEW" + ], + "documentation":"

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

" + }, + "ScalarAttributeType":{ + "type":"string", + "enum":[ + "S", + "N", + "B" + ] + }, + "ScanInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table in which you want to scan. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + }, + "AttributesToGet":{"shape":"AttributeNameList"}, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan.

" + }, + "Count":{ + "shape":"BooleanObject", + "documentation":"

If set to true, Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.

" + }, + "ScanFilter":{ + "shape":"FilterConditionMap", + "documentation":"

Evaluates the scan results and returns only the desired values.

" + }, + "ExclusiveStartKey":{ + "shape":"Key", + "documentation":"

Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new scan request to continue the operation from that point.

" + } + } + }, + "ScanOutput":{ + "type":"structure", + "members":{ + "Items":{"shape":"ItemList"}, + "Count":{ + "shape":"Integer", + "documentation":"

Number of items in the response.

" + }, + "ScannedCount":{ + "shape":"Integer", + "documentation":"

Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

" + }, + "LastEvaluatedKey":{ + "shape":"Key", + "documentation":"

Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the \"last page\").

" + }, + "ConsumedCapacityUnits":{"shape":"ConsumedCapacityUnits"} + } + }, + "String":{"type":"string"}, + "StringAttributeValue":{"type":"string"}, + "StringSetAttributeValue":{ + "type":"list", + "member":{"shape":"StringAttributeValue"} + }, + "TableDescription":{ + "type":"structure", + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table being described.

" + }, + "KeySchema":{"shape":"KeySchema"}, + "TableStatus":{"shape":"TableStatus"}, + "CreationDateTime":{"shape":"Date"}, + "ProvisionedThroughput":{"shape":"ProvisionedThroughputDescription"}, + "TableSizeBytes":{"shape":"Long"}, + "ItemCount":{"shape":"Long"} + } + }, + "TableName":{ + "type":"string", + "min":3, + "max":255, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "TableNameList":{ + "type":"list", + "member":{"shape":"TableName"} + }, + "TableStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE" + ] + }, + "UpdateItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key", + "AttributeUpdates" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table in which you want to update an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + }, + "Key":{"shape":"Key"}, + "AttributeUpdates":{"shape":"AttributeUpdates"}, + "Expected":{"shape":"ExpectedAttributeMap"}, + "ReturnValues":{"shape":"ReturnValue"} + } + }, + "UpdateItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

A map of attribute name-value pairs, but only if the ReturnValues parameter is specified as something other than NONE in the request.

" + }, + "ConsumedCapacityUnits":{"shape":"ConsumedCapacityUnits"} + } + }, + "UpdateTableInput":{ + "type":"structure", + "required":[ + "TableName", + "ProvisionedThroughput" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table you want to update. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

" + }, + "ProvisionedThroughput":{"shape":"ProvisionedThroughput"} + } + }, + "UpdateTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{"shape":"TableDescription"} + } + }, + "WriteRequest":{ + "type":"structure", + "members":{ + "PutRequest":{"shape":"PutRequest"}, + "DeleteRequest":{"shape":"DeleteRequest"} + }, + "documentation":"

This structure is a Union of PutRequest and DeleteRequest. It can contain exactly one of PutRequest or DeleteRequest. Never Both. This is enforced in the code.

" + }, + "WriteRequests":{ + "type":"list", + "member":{"shape":"WriteRequest"}, + "min":1, + "max":25 + } + } +} diff --git a/apis/dynamodb-2011-12-05.paginators.json b/apis/dynamodb-2011-12-05.paginators.json new file mode 100644 index 0000000000..d4075e1207 --- /dev/null +++ b/apis/dynamodb-2011-12-05.paginators.json @@ -0,0 +1,26 @@ +{ + "pagination": { + "BatchGetItem": { + "input_token": "RequestItems", + "output_token": "UnprocessedKeys" + }, + "ListTables": { + "input_token": "ExclusiveStartTableName", + "output_token": "LastEvaluatedTableName", + "limit_key": "Limit", + "result_key": "TableNames" + }, + "Query": { + "input_token": "ExclusiveStartKey", + "output_token": "LastEvaluatedKey", + "limit_key": "Limit", + "result_key": "Items" + }, + "Scan": { + "input_token": "ExclusiveStartKey", + "output_token": "LastEvaluatedKey", + "limit_key": "Limit", + "result_key": "Items" + } + } +} diff --git a/apis/dynamodb-2011-12-05.waiters.json b/apis/dynamodb-2011-12-05.waiters.json new file mode 100644 index 0000000000..50a2b217db --- /dev/null +++ b/apis/dynamodb-2011-12-05.waiters.json @@ -0,0 +1,27 @@ +{ + "waiters": { + "__default__": { + "interval": 20, + "max_attempts": 25 + }, + "__TableState": { + "operation": "DescribeTable" + }, + "TableExists": { + "extends": "__TableState", + "description": "Wait until a table exists and can be accessed", + "ignore_errors": [ + "ResourceNotFoundException" + ], + "success_type": "output", + "success_path": "Table.TableStatus", + "success_value": "ACTIVE" + }, + "TableNotExists": { + "extends": "__TableState", + "description": "Wait until a table is deleted", + "success_type": "error", + "success_value": "ResourceNotFoundException" + } + } +} diff --git a/apis/dynamodb-2012-08-10.api.json b/apis/dynamodb-2012-08-10.api.json new file mode 100644 index 0000000000..708e881da0 --- /dev/null +++ b/apis/dynamodb-2012-08-10.api.json @@ -0,0 +1,963 @@ +{ + "metadata": { + "apiVersion": "2012-08-10", + "endpointPrefix": "dynamodb", + "jsonVersion": "1.0", + "serviceAbbreviation": "DynamoDB", + "serviceFullName": "Amazon DynamoDB", + "signatureVersion": "v4", + "targetPrefix": "DynamoDB_20120810", + "protocol": "json" + }, + "operations": { + "BatchGetItem": { + "input": { + "type": "structure", + "required": [ + "RequestItems" + ], + "members": { + "RequestItems": { + "shape": "S2" + }, + "ReturnConsumedCapacity": {} + } + }, + "output": { + "type": "structure", + "members": { + "Responses": { + "type": "map", + "key": {}, + "value": { + "shape": "Sr" + } + }, + "UnprocessedKeys": { + "shape": "S2" + }, + "ConsumedCapacity": { + "shape": "St" + } + } + } + }, + "BatchWriteItem": { + "input": { + "type": "structure", + "required": [ + "RequestItems" + ], + "members": { + "RequestItems": { + "shape": "S10" + }, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {} + } + }, + "output": { + "type": "structure", + "members": { + "UnprocessedItems": { + "shape": "S10" + }, + "ItemCollectionMetrics": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "shape": "S1a" + } + } + }, + "ConsumedCapacity": { + "shape": "St" + } + } + } + }, + "CreateTable": { + "input": { + "type": "structure", + "required": [ + "AttributeDefinitions", + "TableName", + "KeySchema", + "ProvisionedThroughput" + ], + "members": { + "AttributeDefinitions": { + "shape": "S1f" + }, + "TableName": {}, + "KeySchema": { + "shape": "S1j" + }, + "LocalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IndexName", + "KeySchema", + "Projection" + ], + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S1j" + }, + "Projection": { + "shape": "S1o" + } + } + } + }, + "GlobalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "IndexName", + "KeySchema", + "Projection", + "ProvisionedThroughput" + ], + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S1j" + }, + "Projection": { + "shape": "S1o" + }, + "ProvisionedThroughput": { + "shape": "S1u" + } + } + } + }, + "ProvisionedThroughput": { + "shape": "S1u" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S1x" + } + } + } + }, + "DeleteItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "Expected": { + "shape": "S28" + }, + "ConditionalOperator": {}, + "ReturnValues": {}, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S2g" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Ss" + }, + "ConsumedCapacity": { + "shape": "Su" + }, + "ItemCollectionMetrics": { + "shape": "S1a" + } + } + } + }, + "DeleteTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S1x" + } + } + } + }, + "DescribeTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {} + } + }, + "output": { + "type": "structure", + "members": { + "Table": { + "shape": "S1x" + } + } + } + }, + "GetItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "AttributesToGet": { + "shape": "Sj" + }, + "ConsistentRead": { + "type": "boolean" + }, + "ReturnConsumedCapacity": {}, + "ProjectionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + } + } + }, + "output": { + "type": "structure", + "members": { + "Item": { + "shape": "Ss" + }, + "ConsumedCapacity": { + "shape": "Su" + } + } + } + }, + "ListTables": { + "input": { + "type": "structure", + "members": { + "ExclusiveStartTableName": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TableNames": { + "type": "list", + "member": {} + }, + "LastEvaluatedTableName": {} + } + } + }, + "PutItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Item" + ], + "members": { + "TableName": {}, + "Item": { + "shape": "S14" + }, + "Expected": { + "shape": "S28" + }, + "ReturnValues": {}, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {}, + "ConditionalOperator": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S2g" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Ss" + }, + "ConsumedCapacity": { + "shape": "Su" + }, + "ItemCollectionMetrics": { + "shape": "S1a" + } + } + } + }, + "Query": { + "input": { + "type": "structure", + "required": [ + "TableName", + "KeyConditions" + ], + "members": { + "TableName": {}, + "IndexName": {}, + "Select": {}, + "AttributesToGet": { + "shape": "Sj" + }, + "Limit": { + "type": "integer" + }, + "ConsistentRead": { + "type": "boolean" + }, + "KeyConditions": { + "type": "map", + "key": {}, + "value": { + "shape": "S2z" + } + }, + "QueryFilter": { + "shape": "S30" + }, + "ConditionalOperator": {}, + "ScanIndexForward": { + "type": "boolean" + }, + "ExclusiveStartKey": { + "shape": "S6" + }, + "ReturnConsumedCapacity": {}, + "ProjectionExpression": {}, + "FilterExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S2g" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "shape": "Sr" + }, + "Count": { + "type": "integer" + }, + "ScannedCount": { + "type": "integer" + }, + "LastEvaluatedKey": { + "shape": "S6" + }, + "ConsumedCapacity": { + "shape": "Su" + } + } + } + }, + "Scan": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {}, + "AttributesToGet": { + "shape": "Sj" + }, + "Limit": { + "type": "integer" + }, + "Select": {}, + "ScanFilter": { + "shape": "S30" + }, + "ConditionalOperator": {}, + "ExclusiveStartKey": { + "shape": "S6" + }, + "ReturnConsumedCapacity": {}, + "TotalSegments": { + "type": "integer" + }, + "Segment": { + "type": "integer" + }, + "ProjectionExpression": {}, + "FilterExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S2g" + } + } + }, + "output": { + "type": "structure", + "members": { + "Items": { + "shape": "Sr" + }, + "Count": { + "type": "integer" + }, + "ScannedCount": { + "type": "integer" + }, + "LastEvaluatedKey": { + "shape": "S6" + }, + "ConsumedCapacity": { + "shape": "Su" + } + } + } + }, + "UpdateItem": { + "input": { + "type": "structure", + "required": [ + "TableName", + "Key" + ], + "members": { + "TableName": {}, + "Key": { + "shape": "S6" + }, + "AttributeUpdates": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Value": { + "shape": "S8" + }, + "Action": {} + } + } + }, + "Expected": { + "shape": "S28" + }, + "ConditionalOperator": {}, + "ReturnValues": {}, + "ReturnConsumedCapacity": {}, + "ReturnItemCollectionMetrics": {}, + "UpdateExpression": {}, + "ConditionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + }, + "ExpressionAttributeValues": { + "shape": "S2g" + } + } + }, + "output": { + "type": "structure", + "members": { + "Attributes": { + "shape": "Ss" + }, + "ConsumedCapacity": { + "shape": "Su" + }, + "ItemCollectionMetrics": { + "shape": "S1a" + } + } + } + }, + "UpdateTable": { + "input": { + "type": "structure", + "required": [ + "TableName" + ], + "members": { + "TableName": {}, + "ProvisionedThroughput": { + "shape": "S1u" + }, + "GlobalSecondaryIndexUpdates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Update": { + "type": "structure", + "required": [ + "IndexName", + "ProvisionedThroughput" + ], + "members": { + "IndexName": {}, + "ProvisionedThroughput": { + "shape": "S1u" + } + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "TableDescription": { + "shape": "S1x" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "Keys" + ], + "members": { + "Keys": { + "type": "list", + "member": { + "shape": "S6" + } + }, + "AttributesToGet": { + "shape": "Sj" + }, + "ConsistentRead": { + "type": "boolean" + }, + "ProjectionExpression": {}, + "ExpressionAttributeNames": { + "shape": "Sm" + } + } + } + }, + "S6": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "S8": { + "type": "structure", + "members": { + "S": {}, + "N": {}, + "B": { + "type": "blob" + }, + "SS": { + "type": "list", + "member": {} + }, + "NS": { + "type": "list", + "member": {} + }, + "BS": { + "type": "list", + "member": { + "type": "blob" + } + }, + "M": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "L": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "NULL": { + "type": "boolean" + }, + "BOOL": { + "type": "boolean" + } + } + }, + "Sj": { + "type": "list", + "member": {} + }, + "Sm": { + "type": "map", + "key": {}, + "value": {} + }, + "Sr": { + "type": "list", + "member": { + "shape": "Ss" + } + }, + "Ss": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "St": { + "type": "list", + "member": { + "shape": "Su" + } + }, + "Su": { + "type": "structure", + "members": { + "TableName": {}, + "CapacityUnits": { + "type": "double" + }, + "Table": { + "shape": "Sw" + }, + "LocalSecondaryIndexes": { + "shape": "Sx" + }, + "GlobalSecondaryIndexes": { + "shape": "Sx" + } + } + }, + "Sw": { + "type": "structure", + "members": { + "CapacityUnits": { + "type": "double" + } + } + }, + "Sx": { + "type": "map", + "key": {}, + "value": { + "shape": "Sw" + } + }, + "S10": { + "type": "map", + "key": {}, + "value": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PutRequest": { + "type": "structure", + "required": [ + "Item" + ], + "members": { + "Item": { + "shape": "S14" + } + } + }, + "DeleteRequest": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": { + "shape": "S6" + } + } + } + } + } + } + }, + "S14": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "S1a": { + "type": "structure", + "members": { + "ItemCollectionKey": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "SizeEstimateRangeGB": { + "type": "list", + "member": { + "type": "double" + } + } + } + }, + "S1f": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AttributeName", + "AttributeType" + ], + "members": { + "AttributeName": {}, + "AttributeType": {} + } + } + }, + "S1j": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AttributeName", + "KeyType" + ], + "members": { + "AttributeName": {}, + "KeyType": {} + } + } + }, + "S1o": { + "type": "structure", + "members": { + "ProjectionType": {}, + "NonKeyAttributes": { + "type": "list", + "member": {} + } + } + }, + "S1u": { + "type": "structure", + "required": [ + "ReadCapacityUnits", + "WriteCapacityUnits" + ], + "members": { + "ReadCapacityUnits": { + "type": "long" + }, + "WriteCapacityUnits": { + "type": "long" + } + } + }, + "S1x": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "shape": "S1f" + }, + "TableName": {}, + "KeySchema": { + "shape": "S1j" + }, + "TableStatus": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "ProvisionedThroughput": { + "shape": "S20" + }, + "TableSizeBytes": { + "type": "long" + }, + "ItemCount": { + "type": "long" + }, + "LocalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S1j" + }, + "Projection": { + "shape": "S1o" + }, + "IndexSizeBytes": { + "type": "long" + }, + "ItemCount": { + "type": "long" + } + } + } + }, + "GlobalSecondaryIndexes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IndexName": {}, + "KeySchema": { + "shape": "S1j" + }, + "Projection": { + "shape": "S1o" + }, + "IndexStatus": {}, + "ProvisionedThroughput": { + "shape": "S20" + }, + "IndexSizeBytes": { + "type": "long" + }, + "ItemCount": { + "type": "long" + } + } + } + } + } + }, + "S20": { + "type": "structure", + "members": { + "LastIncreaseDateTime": { + "type": "timestamp" + }, + "LastDecreaseDateTime": { + "type": "timestamp" + }, + "NumberOfDecreasesToday": { + "type": "long" + }, + "ReadCapacityUnits": { + "type": "long" + }, + "WriteCapacityUnits": { + "type": "long" + } + } + }, + "S28": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": { + "Value": { + "shape": "S8" + }, + "Exists": { + "type": "boolean" + }, + "ComparisonOperator": {}, + "AttributeValueList": { + "shape": "S2c" + } + } + } + }, + "S2c": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "S2g": { + "type": "map", + "key": {}, + "value": { + "shape": "S8" + } + }, + "S2z": { + "type": "structure", + "required": [ + "ComparisonOperator" + ], + "members": { + "AttributeValueList": { + "shape": "S2c" + }, + "ComparisonOperator": {} + } + }, + "S30": { + "type": "map", + "key": {}, + "value": { + "shape": "S2z" + } + } + } +} \ No newline at end of file diff --git a/apis/dynamodb-2012-08-10.full.json b/apis/dynamodb-2012-08-10.full.json new file mode 100644 index 0000000000..63d87961b2 --- /dev/null +++ b/apis/dynamodb-2012-08-10.full.json @@ -0,0 +1,1987 @@ +{ + "metadata":{ + "apiVersion":"2012-08-10", + "endpointPrefix":"dynamodb", + "jsonVersion":"1.0", + "serviceAbbreviation":"DynamoDB", + "serviceFullName":"Amazon DynamoDB", + "signatureVersion":"v4", + "targetPrefix":"DynamoDB_20120810", + "protocol":"json" + }, + "documentation":"Amazon DynamoDB Overview

This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the low-level DynamoDB API. For information about DynamoDB application development, go to the Amazon DynamoDB Developer Guide.

Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, go to Using the AWS SDKs with DynamoDB in the Amazon DynamoDB Developer Guide.

If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, go to Using the DynamoDB API in the Amazon DynamoDB Developer Guide.

The following are short descriptions of each low-level API action, organized by function.

Managing Tables

For conceptual information about managing tables, go to Working with Tables in the Amazon DynamoDB Developer Guide.

Reading Data

For conceptual information about reading data, go to Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide.

Modifying Data

For conceptual information about modifying data, go to Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide.

", + "operations":{ + "BatchGetItem":{ + "name":"BatchGetItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"BatchGetItemInput", + "documentation":"

Represents the input of a BatchGetItem operation.

" + }, + "output":{ + "shape":"BatchGetItemOutput", + "documentation":"

Represents the output of a BatchGetItem operation.

" + }, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, go to Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.

" + }, + "BatchWriteItem":{ + "name":"BatchWriteItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"BatchWriteItemInput", + "documentation":"

Represents the input of a BatchWriteItem operation.

" + }, + "output":{ + "shape":"BatchWriteItemOutput", + "documentation":"

Represents the output of a BatchWriteItem operation.

" + }, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"ItemCollectionSizeLimitExceededException", + "exception":true, + "documentation":"

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem will return a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, go to Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, such as Java, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, such as PHP, you must update or delete the specified items one at a time. In both situations, BatchWriteItem provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

" + }, + "CreateTable":{ + "name":"CreateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateTableInput", + "documentation":"

Represents the input of a CreateTable operation.

" + }, + "output":{ + "shape":"CreateTableOutput", + "documentation":"

Represents the output of a CreateTable operation.

" + }, + "errors":[ + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.

Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

The total limit of tables in the ACTIVE state is 250.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

If you want to create multiple tables with secondary indexes on them, you must create them sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable API to check the table status.

" + }, + "DeleteItem":{ + "name":"DeleteItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteItemInput", + "documentation":"

Represents the input of a DeleteItem operation.

" + }, + "output":{ + "shape":"DeleteItemOutput", + "documentation":"

Represents the output of a DeleteItem operation.

" + }, + "errors":[ + { + "shape":"ConditionalCheckFailedException", + "exception":true, + "documentation":"

A condition specified in the operation could not be evaluated.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"ItemCollectionSizeLimitExceededException", + "exception":true, + "documentation":"

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

" + }, + "DeleteTable":{ + "name":"DeleteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteTableInput", + "documentation":"

Represents the input of a DeleteTable operation.

" + }, + "output":{ + "shape":"DeleteTableOutput", + "documentation":"

Represents the output of a DeleteTable operation.

" + }, + "errors":[ + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.

Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

The total limit of tables in the ACTIVE state is 250.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

When you delete a table, any indexes on that table are also deleted.

Use the DescribeTable API to check the status of the table.

" + }, + "DescribeTable":{ + "name":"DescribeTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeTableInput", + "documentation":"

Represents the input of a DescribeTable operation.

" + }, + "output":{ + "shape":"DescribeTableOutput", + "documentation":"

Represents the output of a DescribeTable operation.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

" + }, + "GetItem":{ + "name":"GetItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetItemInput", + "documentation":"

Represents the input of a GetItem operation.

" + }, + "output":{ + "shape":"GetItemOutput", + "documentation":"

Represents the output of a GetItem operation.

" + }, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

" + }, + "ListTables":{ + "name":"ListTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListTablesInput", + "documentation":"

Represents the input of a ListTables operation.

" + }, + "output":{ + "shape":"ListTablesOutput", + "documentation":"

Represents the output of a ListTables operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

" + }, + "PutItem":{ + "name":"PutItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PutItemInput", + "documentation":"

Represents the input of a PutItem operation.

" + }, + "output":{ + "shape":"PutItemOutput", + "documentation":"

Represents the output of a PutItem operation.

" + }, + "errors":[ + { + "shape":"ConditionalCheckFailedException", + "exception":true, + "documentation":"

A condition specified in the operation could not be evaluated.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"ItemCollectionSizeLimitExceededException", + "exception":true, + "documentation":"

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.

In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.

You can request that PutItem return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the ReturnValues description below.

For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.

" + }, + "Query":{ + "name":"Query", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"QueryInput", + "documentation":"

Represents the input of a Query operation.

" + }, + "output":{ + "shape":"QueryOutput", + "documentation":"

Represents the output of a Query operation.

" + }, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

A Query operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the ScanIndexForward parameter to get results in forward or reverse order, by range key or by index key.

Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with LastEvaluatedKey to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns both an empty result set and a LastEvaluatedKey. The LastEvaluatedKey is only provided if the results exceed 1 MB, or if you have used Limit.

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set ConsistentRead to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

" + }, + "Scan":{ + "name":"Scan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ScanInput", + "documentation":"

Represents the input of a Scan operation.

" + }, + "output":{ + "shape":"ScanOutput", + "documentation":"

Represents the output of a Scan operation.

" + }, + "errors":[ + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

The Scan operation returns one or more items and item attributes by accessing every item in the table. To have DynamoDB return fewer items, you can provide a ScanFilter operation.

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

The result set is eventually consistent.

By default, Scan operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel Scan operation by specifying the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

" + }, + "UpdateItem":{ + "name":"UpdateItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateItemInput", + "documentation":"

Represents the input of an UpdateItem operation.

" + }, + "output":{ + "shape":"UpdateItemOutput", + "documentation":"

Represents the output of an UpdateItem operation.

" + }, + "errors":[ + { + "shape":"ConditionalCheckFailedException", + "exception":true, + "documentation":"

A condition specified in the operation could not be evaluated.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"ItemCollectionSizeLimitExceededException", + "exception":true, + "documentation":"

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

" + }, + "UpdateTable":{ + "name":"UpdateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateTableInput", + "documentation":"

Represents the input of an UpdateTable operation.

" + }, + "output":{ + "shape":"UpdateTableOutput", + "documentation":"

Represents the output of an UpdateTable operation.

" + }, + "errors":[ + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.

Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

The total limit of tables in the ACTIVE state is 250.

" + }, + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + } + ], + "documentation":"

Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of DynamoDB.

The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the Limits section in the Amazon DynamoDB Developer Guide.

The table must be in the ACTIVE state for this operation to succeed. UpdateTable is an asynchronous operation; while executing the operation, the table is in the UPDATING state. While the table is in the UPDATING state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the ACTIVE state after the UpdateTable operation.

You cannot add, modify or delete indexes using UpdateTable. Indexes can only be defined at table creation time.

" + } + }, + "shapes":{ + "AttributeAction":{ + "type":"string", + "enum":[ + "ADD", + "PUT", + "DELETE" + ] + }, + "AttributeDefinition":{ + "type":"structure", + "required":[ + "AttributeName", + "AttributeType" + ], + "members":{ + "AttributeName":{ + "shape":"KeySchemaAttributeName", + "documentation":"

A name for the attribute.

" + }, + "AttributeType":{ + "shape":"ScalarAttributeType", + "documentation":"

The data type for the attribute.

" + } + }, + "documentation":"

Represents an attribute for describing the key schema for the table and indexes.

" + }, + "AttributeDefinitions":{ + "type":"list", + "member":{"shape":"AttributeDefinition"} + }, + "AttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AttributeName":{ + "type":"string", + "max":65535 + }, + "AttributeNameList":{ + "type":"list", + "member":{"shape":"AttributeName"}, + "min":1 + }, + "AttributeUpdates":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValueUpdate"} + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "S":{ + "shape":"StringAttributeValue", + "documentation":"

A String data type.

" + }, + "N":{ + "shape":"NumberAttributeValue", + "documentation":"

A Number data type.

" + }, + "B":{ + "shape":"BinaryAttributeValue", + "documentation":"

A Binary data type.

" + }, + "SS":{ + "shape":"StringSetAttributeValue", + "documentation":"

A String Set data type.

" + }, + "NS":{ + "shape":"NumberSetAttributeValue", + "documentation":"

A Number Set data type.

" + }, + "BS":{ + "shape":"BinarySetAttributeValue", + "documentation":"

A Binary Set data type.

" + }, + "M":{ + "shape":"MapAttributeValue", + "documentation":"

A Map of attribute values.

" + }, + "L":{ + "shape":"ListAttributeValue", + "documentation":"

A List of attribute values.

" + }, + "NULL":{ + "shape":"NullAttributeValue", + "documentation":"

A Null data type.

" + }, + "BOOL":{ + "shape":"BooleanAttributeValue", + "documentation":"

A Boolean data type.

" + } + }, + "documentation":"

Represents the data for an attribute. You can set one, and only one, of the elements.

Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

" + }, + "AttributeValueList":{ + "type":"list", + "member":{"shape":"AttributeValue"} + }, + "AttributeValueUpdate":{ + "type":"structure", + "members":{ + "Value":{"shape":"AttributeValue"}, + "Action":{ + "shape":"AttributeAction", + "documentation":"

Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

If an item with the specified Key is found in the table:

If no item with the specified Key is found:

" + } + }, + "documentation":"

For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.

Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

" + }, + "BatchGetItemInput":{ + "type":"structure", + "required":["RequestItems"], + "members":{ + "RequestItems":{ + "shape":"BatchGetRequestMap", + "documentation":"

A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.

Each element in the map consists of the following:

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"} + }, + "documentation":"

Represents the input of a BatchGetItem operation.

" + }, + "BatchGetItemOutput":{ + "type":"structure", + "members":{ + "Responses":{ + "shape":"BatchGetResponseMap", + "documentation":"

A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

" + }, + "UnprocessedKeys":{ + "shape":"BatchGetRequestMap", + "documentation":"

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacityMultiple", + "documentation":"

The write capacity units consumed by the operation.

Each element consists of:

" + } + }, + "documentation":"

Represents the output of a BatchGetItem operation.

" + }, + "BatchGetRequestMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"KeysAndAttributes"}, + "min":1, + "max":100 + }, + "BatchGetResponseMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"ItemList"} + }, + "BatchWriteItemInput":{ + "type":"structure", + "required":["RequestItems"], + "members":{ + "RequestItems":{ + "shape":"BatchWriteItemRequestMap", + "documentation":"

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

A value that if set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + } + }, + "documentation":"

Represents the input of a BatchWriteItem operation.

" + }, + "BatchWriteItemOutput":{ + "type":"structure", + "members":{ + "UnprocessedItems":{ + "shape":"BatchWriteItemRequestMap", + "documentation":"

A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

" + }, + "ItemCollectionMetrics":{ + "shape":"ItemCollectionMetricsPerTable", + "documentation":"

A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

Each entry consists of the following subelements:

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacityMultiple", + "documentation":"

The capacity units consumed by the operation.

Each element consists of:

" + } + }, + "documentation":"

Represents the output of a BatchWriteItem operation.

" + }, + "BatchWriteItemRequestMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"WriteRequests"}, + "min":1, + "max":25 + }, + "BinaryAttributeValue":{"type":"blob"}, + "BinarySetAttributeValue":{ + "type":"list", + "member":{"shape":"BinaryAttributeValue"} + }, + "BooleanAttributeValue":{"type":"boolean"}, + "BooleanObject":{"type":"boolean"}, + "Capacity":{ + "type":"structure", + "members":{ + "CapacityUnits":{ + "shape":"ConsumedCapacityUnits", + "documentation":"

The total number of capacity units consumed on a table or an index.

" + } + }, + "documentation":"

Represents the amount of provisioned throughput capacity consumed on a table or an index.

" + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "NE", + "IN", + "LE", + "LT", + "GE", + "GT", + "BETWEEN", + "NOT_NULL", + "NULL", + "CONTAINS", + "NOT_CONTAINS", + "BEGINS_WITH" + ] + }, + "Condition":{ + "type":"structure", + "required":["ComparisonOperator"], + "members":{ + "AttributeValueList":{ + "shape":"AttributeValueList", + "documentation":"

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the selection criteria for a Query or Scan operation:

" + }, + "ConditionExpression":{"type":"string"}, + "ConditionalCheckFailedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The conditional request failed.

" + } + }, + "exception":true, + "documentation":"

A condition specified in the operation could not be evaluated.

" + }, + "ConditionalOperator":{ + "type":"string", + "enum":[ + "AND", + "OR" + ] + }, + "ConsistentRead":{"type":"boolean"}, + "ConsumedCapacity":{ + "type":"structure", + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table that was affected by the operation.

" + }, + "CapacityUnits":{ + "shape":"ConsumedCapacityUnits", + "documentation":"

The total number of capacity units consumed by the operation.

" + }, + "Table":{ + "shape":"Capacity", + "documentation":"

The amount of throughput consumed on the table affected by the operation.

" + }, + "LocalSecondaryIndexes":{ + "shape":"SecondaryIndexesCapacityMap", + "documentation":"

The amount of throughput consumed on each local index affected by the operation.

" + }, + "GlobalSecondaryIndexes":{ + "shape":"SecondaryIndexesCapacityMap", + "documentation":"

The amount of throughput consumed on each global index affected by the operation.

" + } + }, + "documentation":"

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + }, + "ConsumedCapacityMultiple":{ + "type":"list", + "member":{"shape":"ConsumedCapacity"} + }, + "ConsumedCapacityUnits":{"type":"double"}, + "CreateTableInput":{ + "type":"structure", + "required":[ + "AttributeDefinitions", + "TableName", + "KeySchema", + "ProvisionedThroughput" + ], + "members":{ + "AttributeDefinitions":{ + "shape":"AttributeDefinitions", + "documentation":"

An array of attributes that describe the key schema for the table and indexes.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to create.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

For a primary key that consists of a hash attribute, you must specify exactly one element with a KeyType of HASH.

For a primary key that consists of hash and range attributes, you must specify exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

" + }, + "LocalSecondaryIndexes":{ + "shape":"LocalSecondaryIndexList", + "documentation":"

One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 GB size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

" + }, + "GlobalSecondaryIndexes":{ + "shape":"GlobalSecondaryIndexList", + "documentation":"

One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:

" + }, + "ProvisionedThroughput":{"shape":"ProvisionedThroughput"} + }, + "documentation":"

Represents the input of a CreateTable operation.

" + }, + "CreateTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{"shape":"TableDescription"} + }, + "documentation":"

Represents the output of a CreateTable operation.

" + }, + "Date":{"type":"timestamp"}, + "DeleteItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table from which to delete the item.

" + }, + "Key":{ + "shape":"Key", + "documentation":"

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.

" + }, + "Expected":{ + "shape":"ExpectedAttributeMap", + "documentation":"

There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Expected contains the following:

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

" + }, + "ReturnValues":{ + "shape":"ReturnValue", + "documentation":"

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

A value that if set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:

Use the # character in an expression to dereference an attribute name. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeNames:

The expression can now be simplified as follows:

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : character in an expression to dereference an attribute value. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeValues:

The expression can now be simplified as follows:

" + } + }, + "documentation":"

Represents the input of a DeleteItem operation.

" + }, + "DeleteItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

" + }, + "ConsumedCapacity":{"shape":"ConsumedCapacity"}, + "ItemCollectionMetrics":{ + "shape":"ItemCollectionMetrics", + "documentation":"

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

" + } + }, + "documentation":"

Represents the output of a DeleteItem operation.

" + }, + "DeleteRequest":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

" + } + }, + "documentation":"

Represents a request to perform a DeleteItem operation on an item.

" + }, + "DeleteTableInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to delete.

" + } + }, + "documentation":"

Represents the input of a DeleteTable operation.

" + }, + "DeleteTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{"shape":"TableDescription"} + }, + "documentation":"

Represents the output of a DeleteTable operation.

" + }, + "DescribeTableInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to describe.

" + } + }, + "documentation":"

Represents the input of a DescribeTable operation.

" + }, + "DescribeTableOutput":{ + "type":"structure", + "members":{ + "Table":{"shape":"TableDescription"} + }, + "documentation":"

Represents the output of a DescribeTable operation.

" + }, + "ErrorMessage":{"type":"string"}, + "ExpectedAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"ExpectedAttributeValue"} + }, + "ExpectedAttributeValue":{ + "type":"structure", + "members":{ + "Value":{"shape":"AttributeValue"}, + "Exists":{ + "shape":"BooleanObject", + "documentation":"

Causes DynamoDB to evaluate the value before attempting a conditional operation:

The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

DynamoDB returns a ValidationException if:

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

" + }, + "AttributeValueList":{ + "shape":"AttributeValueList", + "documentation":"

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:

Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

" + }, + "ExpressionAttributeNameMap":{ + "type":"map", + "key":{"shape":"ExpressionAttributeNameVariable"}, + "value":{"shape":"AttributeName"} + }, + "ExpressionAttributeNameVariable":{"type":"string"}, + "ExpressionAttributeValueMap":{ + "type":"map", + "key":{"shape":"ExpressionAttributeValueVariable"}, + "value":{"shape":"AttributeValue"} + }, + "ExpressionAttributeValueVariable":{"type":"string"}, + "FilterConditionMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"Condition"} + }, + "GetItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table containing the requested item.

" + }, + "Key":{ + "shape":"Key", + "documentation":"

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.

" + }, + "AttributesToGet":{ + "shape":"AttributeNameList", + "documentation":"

There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.

The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

" + }, + "ConsistentRead":{ + "shape":"ConsistentRead", + "documentation":"

A value that if set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:

Use the # character in an expression to dereference an attribute name. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeNames:

The expression can now be simplified as follows:

" + } + }, + "documentation":"

Represents the input of a GetItem operation.

" + }, + "GetItemOutput":{ + "type":"structure", + "members":{ + "Item":{ + "shape":"AttributeMap", + "documentation":"

A map of attribute names to AttributeValue objects, as specified by AttributesToGet.

" + }, + "ConsumedCapacity":{"shape":"ConsumedCapacity"} + }, + "documentation":"

Represents the output of a GetItem operation.

" + }, + "GlobalSecondaryIndex":{ + "type":"structure", + "required":[ + "IndexName", + "KeySchema", + "Projection", + "ProvisionedThroughput" + ], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index. The name must be unique among all other indexes on this table.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

" + }, + "Projection":{"shape":"Projection"}, + "ProvisionedThroughput":{"shape":"ProvisionedThroughput"} + }, + "documentation":"

Represents a global secondary index.

" + }, + "GlobalSecondaryIndexDescription":{ + "type":"structure", + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

" + }, + "Projection":{"shape":"Projection"}, + "IndexStatus":{ + "shape":"IndexStatus", + "documentation":"

The current state of the global secondary index:

" + }, + "ProvisionedThroughput":{"shape":"ProvisionedThroughputDescription"}, + "IndexSizeBytes":{ + "shape":"Long", + "documentation":"

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "ItemCount":{ + "shape":"Long", + "documentation":"

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + } + }, + "documentation":"

Represents the properties of a global secondary index.

" + }, + "GlobalSecondaryIndexDescriptionList":{ + "type":"list", + "member":{"shape":"GlobalSecondaryIndexDescription"} + }, + "GlobalSecondaryIndexList":{ + "type":"list", + "member":{"shape":"GlobalSecondaryIndex"} + }, + "GlobalSecondaryIndexUpdate":{ + "type":"structure", + "members":{ + "Update":{ + "shape":"UpdateGlobalSecondaryIndexAction", + "documentation":"

The name of a global secondary index, along with the updated provisioned throughput settings that are to be applied to that index.

" + } + }, + "documentation":"

Represents the new provisioned throughput settings to apply to a global secondary index.

" + }, + "GlobalSecondaryIndexUpdateList":{ + "type":"list", + "member":{"shape":"GlobalSecondaryIndexUpdate"} + }, + "IndexName":{ + "type":"string", + "min":3, + "max":255, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "IndexStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE" + ] + }, + "Integer":{"type":"integer"}, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The server encountered an internal error trying to fulfill the request.

" + } + }, + "exception":true, + "fault":true, + "documentation":"

An error occurred on the server side.

" + }, + "ItemCollectionKeyAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "ItemCollectionMetrics":{ + "type":"structure", + "members":{ + "ItemCollectionKey":{ + "shape":"ItemCollectionKeyAttributeMap", + "documentation":"

The hash key value of the item collection. This value is the same as the hash key of the item.

" + }, + "SizeEstimateRangeGB":{ + "shape":"ItemCollectionSizeEstimateRange", + "documentation":"

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" + } + }, + "documentation":"

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

" + }, + "ItemCollectionMetricsMultiple":{ + "type":"list", + "member":{"shape":"ItemCollectionMetrics"} + }, + "ItemCollectionMetricsPerTable":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"ItemCollectionMetricsMultiple"} + }, + "ItemCollectionSizeEstimateBound":{"type":"double"}, + "ItemCollectionSizeEstimateRange":{ + "type":"list", + "member":{"shape":"ItemCollectionSizeEstimateBound"} + }, + "ItemCollectionSizeLimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The total size of an item collection has exceeded the maximum limit of 10 gigabytes.

" + } + }, + "exception":true, + "documentation":"

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

" + }, + "ItemList":{ + "type":"list", + "member":{"shape":"AttributeMap"} + }, + "Key":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "KeyConditions":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"Condition"} + }, + "KeyList":{ + "type":"list", + "member":{"shape":"Key"}, + "min":1, + "max":100 + }, + "KeySchema":{ + "type":"list", + "member":{"shape":"KeySchemaElement"}, + "min":1, + "max":2 + }, + "KeySchemaAttributeName":{ + "type":"string", + "min":1, + "max":255 + }, + "KeySchemaElement":{ + "type":"structure", + "required":[ + "AttributeName", + "KeyType" + ], + "members":{ + "AttributeName":{ + "shape":"KeySchemaAttributeName", + "documentation":"

The name of a key attribute.

" + }, + "KeyType":{ + "shape":"KeyType", + "documentation":"

The attribute data, consisting of the data type and the attribute value itself.

" + } + }, + "documentation":"

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a hash type primary key would be represented by one KeySchemaElement. A hash-and-range type primary key would require one KeySchemaElement for the hash attribute, and another KeySchemaElement for the range attribute.

" + }, + "KeyType":{ + "type":"string", + "enum":[ + "HASH", + "RANGE" + ] + }, + "KeysAndAttributes":{ + "type":"structure", + "required":["Keys"], + "members":{ + "Keys":{ + "shape":"KeyList", + "documentation":"

The primary key attribute values that define the items and the attributes associated with the items.

" + }, + "AttributesToGet":{ + "shape":"AttributeNameList", + "documentation":"

One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

" + }, + "ConsistentRead":{ + "shape":"ConsistentRead", + "documentation":"

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

" + }, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:

Use the # character in an expression to dereference an attribute name. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeNames:

The expression can now be simplified as follows:

" + } + }, + "documentation":"

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Too many operations for a given subscriber.

" + } + }, + "exception":true, + "documentation":"

The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.

Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

The total limit of tables in the ACTIVE state is 250.

" + }, + "ListAttributeValue":{ + "type":"list", + "member":{"shape":"AttributeValue"} + }, + "ListTablesInput":{ + "type":"structure", + "members":{ + "ExclusiveStartTableName":{ + "shape":"TableName", + "documentation":"

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

" + }, + "Limit":{ + "shape":"ListTablesInputLimit", + "documentation":"

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

" + } + }, + "documentation":"

Represents the input of a ListTables operation.

" + }, + "ListTablesInputLimit":{ + "type":"integer", + "min":1, + "max":100 + }, + "ListTablesOutput":{ + "type":"structure", + "members":{ + "TableNames":{ + "shape":"TableNameList", + "documentation":"

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

" + }, + "LastEvaluatedTableName":{ + "shape":"TableName", + "documentation":"

The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

" + } + }, + "documentation":"

Represents the output of a ListTables operation.

" + }, + "LocalSecondaryIndex":{ + "type":"structure", + "required":[ + "IndexName", + "KeySchema", + "Projection" + ], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the local secondary index. The name must be unique among all other indexes on this table.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

" + }, + "Projection":{"shape":"Projection"} + }, + "documentation":"

Represents a local secondary index.

" + }, + "LocalSecondaryIndexDescription":{ + "type":"structure", + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

Represents the name of the local secondary index.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

" + }, + "Projection":{"shape":"Projection"}, + "IndexSizeBytes":{ + "shape":"Long", + "documentation":"

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "ItemCount":{ + "shape":"Long", + "documentation":"

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + } + }, + "documentation":"

Represents the properties of a local secondary index.

" + }, + "LocalSecondaryIndexDescriptionList":{ + "type":"list", + "member":{"shape":"LocalSecondaryIndexDescription"} + }, + "LocalSecondaryIndexList":{ + "type":"list", + "member":{"shape":"LocalSecondaryIndex"} + }, + "Long":{"type":"long"}, + "MapAttributeValue":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "NonKeyAttributeName":{ + "type":"string", + "min":1, + "max":255 + }, + "NonKeyAttributeNameList":{ + "type":"list", + "member":{"shape":"NonKeyAttributeName"}, + "min":1, + "max":20 + }, + "NullAttributeValue":{"type":"boolean"}, + "NumberAttributeValue":{"type":"string"}, + "NumberSetAttributeValue":{ + "type":"list", + "member":{"shape":"NumberAttributeValue"} + }, + "PositiveIntegerObject":{ + "type":"integer", + "min":1 + }, + "PositiveLongObject":{ + "type":"long", + "min":1 + }, + "Projection":{ + "type":"structure", + "members":{ + "ProjectionType":{ + "shape":"ProjectionType", + "documentation":"

The set of attributes that are projected into the index:

" + }, + "NonKeyAttributes":{ + "shape":"NonKeyAttributeNameList", + "documentation":"

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

" + } + }, + "documentation":"

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + }, + "ProjectionExpression":{"type":"string"}, + "ProjectionType":{ + "type":"string", + "enum":[ + "ALL", + "KEYS_ONLY", + "INCLUDE" + ] + }, + "ProvisionedThroughput":{ + "type":"structure", + "required":[ + "ReadCapacityUnits", + "WriteCapacityUnits" + ], + "members":{ + "ReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

" + }, + "WriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + }, + "ProvisionedThroughputDescription":{ + "type":"structure", + "members":{ + "LastIncreaseDateTime":{ + "shape":"Date", + "documentation":"

The date and time of the last provisioned throughput increase for this table.

" + }, + "LastDecreaseDateTime":{ + "shape":"Date", + "documentation":"

The date and time of the last provisioned throughput decrease for this table.

" + }, + "NumberOfDecreasesToday":{ + "shape":"PositiveLongObject", + "documentation":"

The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

" + }, + "ReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

" + }, + "WriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

" + } + }, + "documentation":"

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" + }, + "ProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

You exceeded your maximum allowed provisioned throughput.

" + } + }, + "exception":true, + "documentation":"

The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

" + }, + "PutItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Item" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to contain the item.

" + }, + "Item":{ + "shape":"PutItemInputAttributeMap", + "documentation":"

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

" + }, + "Expected":{ + "shape":"ExpectedAttributeMap", + "documentation":"

There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A map of attribute/condition pairs. Expected provides a conditional block for the PutItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Expected contains the following:

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

" + }, + "ReturnValues":{ + "shape":"ReturnValue", + "documentation":"

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

A value that if set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional PutItem operation to succeed.

An expression can contain any of the following:

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:

Use the # character in an expression to dereference an attribute name. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeNames:

The expression can now be simplified as follows:

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : character in an expression to dereference an attribute value. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeValues:

The expression can now be simplified as follows:

" + } + }, + "documentation":"

Represents the input of a PutItem operation.

" + }, + "PutItemInputAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "PutItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

" + }, + "ConsumedCapacity":{"shape":"ConsumedCapacity"}, + "ItemCollectionMetrics":{ + "shape":"ItemCollectionMetrics", + "documentation":"

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

" + } + }, + "documentation":"

Represents the output of a PutItem operation.

" + }, + "PutRequest":{ + "type":"structure", + "required":["Item"], + "members":{ + "Item":{ + "shape":"PutItemInputAttributeMap", + "documentation":"

A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.

" + } + }, + "documentation":"

Represents a request to perform a PutItem operation on an item.

" + }, + "QueryInput":{ + "type":"structure", + "required":[ + "TableName", + "KeyConditions" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table containing the requested items.

" + }, + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of an index to query. This index can be any local secondary index or global secondary index on the table.

" + }, + "Select":{ + "shape":"Select", + "documentation":"

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

" + }, + "AttributesToGet":{ + "shape":"AttributeNameList", + "documentation":"

There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.

The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

You cannot use both AttributesToGet and Select together in a Query request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

" + }, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

" + }, + "ConsistentRead":{ + "shape":"ConsistentRead", + "documentation":"

A value that if set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.

Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive an error message.

" + }, + "KeyConditions":{ + "shape":"KeyConditions", + "documentation":"

The selection criteria for the query. For a query on a table, you can have conditions only on the table primary key attributes. You must specify the hash key attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the range key attribute.

For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.

Each KeyConditions element consists of an attribute name to compare, along with the following:

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

" + }, + "QueryFilter":{ + "shape":"FilterConditionMap", + "documentation":"

There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A condition that evaluates the query results and returns only the desired values.

If you specify more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

Each QueryFilter element consists of an attribute name to compare, along with the following:

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A logical operator to apply to the conditions in the QueryFilter map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

" + }, + "ScanIndexForward":{ + "shape":"BooleanObject", + "documentation":"

A value that specifies ascending (true) or descending (false) traversal of the index. DynamoDB returns results reflecting the requested order determined by the range key. If the data type is Number, the results are returned in numeric order. For type String, the results are returned in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

If ScanIndexForward is not specified, the results are returned in ascending order.

" + }, + "ExclusiveStartKey":{ + "shape":"Key", + "documentation":"

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

" + }, + "FilterExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that evaluates the query results and returns only the desired values.

The condition you specify is applied to the items queried; any items that do not match the expression are not returned.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:

Use the # character in an expression to dereference an attribute name. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeNames:

The expression can now be simplified as follows:

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : character in an expression to dereference an attribute value. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeValues:

The expression can now be simplified as follows:

" + } + }, + "documentation":"

Represents the input of a Query operation.

" + }, + "QueryOutput":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ItemList", + "documentation":"

An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

" + }, + "ScannedCount":{ + "shape":"Integer", + "documentation":"

The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

" + }, + "LastEvaluatedKey":{ + "shape":"Key", + "documentation":"

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

" + }, + "ConsumedCapacity":{"shape":"ConsumedCapacity"} + }, + "documentation":"

Represents the output of a Query operation.

" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The resource which is being attempted to be changed is in use.

" + } + }, + "exception":true, + "documentation":"

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The resource which is being requested does not exist.

" + } + }, + "exception":true, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

" + }, + "ReturnConsumedCapacity":{ + "type":"string", + "enum":[ + "INDEXES", + "TOTAL", + "NONE" + ], + "documentation":"

A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

" + }, + "ReturnItemCollectionMetrics":{ + "type":"string", + "enum":[ + "SIZE", + "NONE" + ] + }, + "ReturnValue":{ + "type":"string", + "enum":[ + "NONE", + "ALL_OLD", + "UPDATED_OLD", + "ALL_NEW", + "UPDATED_NEW" + ] + }, + "ScalarAttributeType":{ + "type":"string", + "enum":[ + "S", + "N", + "B" + ] + }, + "ScanInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table containing the requested items.

" + }, + "AttributesToGet":{ + "shape":"AttributeNameList", + "documentation":"

There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.

The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

" + }, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

" + }, + "Select":{ + "shape":"Select", + "documentation":"

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

" + }, + "ScanFilter":{ + "shape":"FilterConditionMap", + "documentation":"

There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A condition that evaluates the scan results and returns only the desired values.

If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

Each ScanFilter element consists of an attribute name to compare, along with the following:

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A logical operator to apply to the conditions in the ScanFilter map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

" + }, + "ExclusiveStartKey":{ + "shape":"Key", + "documentation":"

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "TotalSegments":{ + "shape":"ScanTotalSegments", + "documentation":"

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to scan a table using four application threads, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

" + }, + "Segment":{ + "shape":"ScanSegment", + "documentation":"

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you specify Segment, you must also specify TotalSegments.

" + }, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

" + }, + "FilterExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that evaluates the scan results and returns only the desired values.

The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:

Use the # character in an expression to dereference an attribute name. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeNames:

The expression can now be simplified as follows:

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : character in an expression to dereference an attribute value. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeValues:

The expression can now be simplified as follows:

" + } + }, + "documentation":"

Represents the input of a Scan operation.

" + }, + "ScanOutput":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ItemList", + "documentation":"

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

" + }, + "ScannedCount":{ + "shape":"Integer", + "documentation":"

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

" + }, + "LastEvaluatedKey":{ + "shape":"Key", + "documentation":"

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

" + }, + "ConsumedCapacity":{"shape":"ConsumedCapacity"} + }, + "documentation":"

Represents the output of a Scan operation.

" + }, + "ScanSegment":{ + "type":"integer", + "min":0, + "max":999999 + }, + "ScanTotalSegments":{ + "type":"integer", + "min":1, + "max":1000000 + }, + "SecondaryIndexesCapacityMap":{ + "type":"map", + "key":{"shape":"IndexName"}, + "value":{"shape":"Capacity"} + }, + "Select":{ + "type":"string", + "enum":[ + "ALL_ATTRIBUTES", + "ALL_PROJECTED_ATTRIBUTES", + "SPECIFIC_ATTRIBUTES", + "COUNT" + ] + }, + "StringAttributeValue":{"type":"string"}, + "StringSetAttributeValue":{ + "type":"list", + "member":{"shape":"StringAttributeValue"} + }, + "TableDescription":{ + "type":"structure", + "members":{ + "AttributeDefinitions":{ + "shape":"AttributeDefinitions", + "documentation":"

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

Each AttributeDefinition object in this array is composed of:

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The primary key structure for the table. Each KeySchemaElement consists of:

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

" + }, + "TableStatus":{ + "shape":"TableStatus", + "documentation":"

The current state of the table:

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the table was created, in UNIX epoch time format.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughputDescription", + "documentation":"

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" + }, + "TableSizeBytes":{ + "shape":"Long", + "documentation":"

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "ItemCount":{ + "shape":"Long", + "documentation":"

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "LocalSecondaryIndexes":{ + "shape":"LocalSecondaryIndexDescriptionList", + "documentation":"

Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

If the table is in the DELETING state, no information about indexes will be returned.

" + }, + "GlobalSecondaryIndexes":{ + "shape":"GlobalSecondaryIndexDescriptionList", + "documentation":"

The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:

If the table is in the DELETING state, no information about indexes will be returned.

" + } + }, + "documentation":"

Represents the properties of a table.

" + }, + "TableName":{ + "type":"string", + "min":3, + "max":255, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "TableNameList":{ + "type":"list", + "member":{"shape":"TableName"} + }, + "TableStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE" + ] + }, + "UpdateExpression":{"type":"string"}, + "UpdateGlobalSecondaryIndexAction":{ + "type":"structure", + "required":[ + "IndexName", + "ProvisionedThroughput" + ], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index to be updated.

" + }, + "ProvisionedThroughput":{"shape":"ProvisionedThroughput"} + }, + "documentation":"

Represents the new provisioned throughput settings to be applied to a global secondary index.

" + }, + "UpdateItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table containing the item to update.

" + }, + "Key":{ + "shape":"Key", + "documentation":"

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.

" + }, + "AttributeUpdates":{ + "shape":"AttributeUpdates", + "documentation":"

There is a newer parameter available. Use UpdateExpression instead. Note that if you use AttributeUpdates and UpdateExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.

The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any nonkey attributes.

Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

" + }, + "Expected":{ + "shape":"ExpectedAttributeMap", + "documentation":"

There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.

Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

Expected contains the following:

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.

This parameter does not support lists or maps.

A logical operator to apply to the conditions in the Expected map:

If you omit ConditionalOperator, then AND is the default.

The operation will succeed only if the entire map evaluates to true.

" + }, + "ReturnValues":{ + "shape":"ReturnValue", + "documentation":"

Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

A value that if set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + }, + "UpdateExpression":{ + "shape":"UpdateExpression", + "documentation":"

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

The following action values are available for UpdateExpression.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

An expression can contain any of the following:

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:

Use the # character in an expression to dereference an attribute name. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeNames:

The expression can now be simplified as follows:

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : character in an expression to dereference an attribute value. For example, consider the following expression:

Now suppose that you specified the following for ExpressionAttributeValues:

The expression can now be simplified as follows:

" + } + }, + "documentation":"

Represents the input of an UpdateItem operation.

" + }, + "UpdateItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

A map of attribute values as they appeared before the UpdateItem operation. This map only appears if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

" + }, + "ConsumedCapacity":{"shape":"ConsumedCapacity"}, + "ItemCollectionMetrics":{"shape":"ItemCollectionMetrics"} + }, + "documentation":"

Represents the output of an UpdateItem operation.

" + }, + "UpdateTableInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to be updated.

" + }, + "ProvisionedThroughput":{"shape":"ProvisionedThroughput"}, + "GlobalSecondaryIndexUpdates":{ + "shape":"GlobalSecondaryIndexUpdateList", + "documentation":"

An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.

" + } + }, + "documentation":"

Represents the input of an UpdateTable operation.

" + }, + "UpdateTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{"shape":"TableDescription"} + }, + "documentation":"

Represents the output of an UpdateTable operation.

" + }, + "WriteRequest":{ + "type":"structure", + "members":{ + "PutRequest":{ + "shape":"PutRequest", + "documentation":"

A request to perform a PutItem operation.

" + }, + "DeleteRequest":{ + "shape":"DeleteRequest", + "documentation":"

A request to perform a DeleteItem operation.

" + } + }, + "documentation":"

Represents an operation to perform - either DeleteItem or PutItem. You can only specify one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to specify two separate WriteRequest objects.

" + }, + "WriteRequests":{ + "type":"list", + "member":{"shape":"WriteRequest"}, + "min":1, + "max":25 + } + } +} diff --git a/apis/dynamodb-2012-08-10.paginators.json b/apis/dynamodb-2012-08-10.paginators.json new file mode 100644 index 0000000000..d4075e1207 --- /dev/null +++ b/apis/dynamodb-2012-08-10.paginators.json @@ -0,0 +1,26 @@ +{ + "pagination": { + "BatchGetItem": { + "input_token": "RequestItems", + "output_token": "UnprocessedKeys" + }, + "ListTables": { + "input_token": "ExclusiveStartTableName", + "output_token": "LastEvaluatedTableName", + "limit_key": "Limit", + "result_key": "TableNames" + }, + "Query": { + "input_token": "ExclusiveStartKey", + "output_token": "LastEvaluatedKey", + "limit_key": "Limit", + "result_key": "Items" + }, + "Scan": { + "input_token": "ExclusiveStartKey", + "output_token": "LastEvaluatedKey", + "limit_key": "Limit", + "result_key": "Items" + } + } +} diff --git a/apis/dynamodb-2012-08-10.waiters.json b/apis/dynamodb-2012-08-10.waiters.json new file mode 100644 index 0000000000..6e0e1045aa --- /dev/null +++ b/apis/dynamodb-2012-08-10.waiters.json @@ -0,0 +1,25 @@ +{ + "waiters": { + "__default__": { + "interval": 20, + "max_attempts": 25 + }, + "__TableState": { + "operation": "DescribeTable" + }, + "TableExists": { + "extends": "__TableState", + "ignore_errors": [ + "ResourceNotFoundException" + ], + "success_type": "output", + "success_path": "Table.TableStatus", + "success_value": "ACTIVE" + }, + "TableNotExists": { + "extends": "__TableState", + "success_type": "error", + "success_value": "ResourceNotFoundException" + } + } +} diff --git a/apis/ec2-2014-06-15.api.json b/apis/ec2-2014-06-15.api.json new file mode 100644 index 0000000000..81f60a8a53 --- /dev/null +++ b/apis/ec2-2014-06-15.api.json @@ -0,0 +1,12839 @@ +{ + "metadata": { + "apiVersion": "2014-06-15", + "protocol": "query", + "resultWrapped": false, + "signatureVersion": "v2", + "serviceFullName": "Amazon Elastic Compute Cloud", + "serviceAbbreviation": "Amazon EC2", + "endpointPrefix": "ec2", + "xmlNamespace": "http://ec2.amazonaws.com/doc/2014-06-15" + }, + "operations": { + "AcceptVpcPeeringConnection": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcPeeringConnectionId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "type": "structure", + "locationName": "vpcPeeringConnection", + "members": { + "AccepterVpcInfo": { + "type": "structure", + "locationName": "accepterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + } + } + }, + "ExpirationTime": { + "type": "timestamp", + "locationName": "expirationTime" + }, + "RequesterVpcInfo": { + "type": "structure", + "locationName": "requesterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + } + } + }, + "Status": { + "type": "structure", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "VpcPeeringConnectionId": { + "type": "string", + "locationName": "vpcPeeringConnectionId" + } + } + } + } + } + }, + "AllocateAddress": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Domain": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "Domain": { + "type": "string", + "locationName": "domain" + }, + "AllocationId": { + "type": "string", + "locationName": "allocationId" + } + } + } + }, + "AssignPrivateIpAddresses": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "NetworkInterfaceId": { + "type": "string" + }, + "PrivateIpAddresses": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "PrivateIpAddress" + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer" + }, + "AllowReassignment": { + "type": "boolean" + } + } + }, + "output": null + }, + "AssociateAddress": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": { + "type": "string" + }, + "PublicIp": { + "type": "string" + }, + "AllocationId": { + "type": "string" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "PrivateIpAddress": { + "type": "string" + }, + "AllowReassociation": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "AssociationId": { + "type": "string", + "locationName": "associationId" + } + } + } + }, + "AssociateDhcpOptions": { + "input": { + "type": "structure", + "required": [ + "DhcpOptionsId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "DhcpOptionsId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": null + }, + "AssociateRouteTable": { + "input": { + "type": "structure", + "required": [ + "SubnetId", + "RouteTableId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SubnetId": { + "type": "string" + }, + "RouteTableId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "AssociationId": { + "type": "string", + "locationName": "associationId" + } + } + } + }, + "AttachInternetGateway": { + "input": { + "type": "structure", + "required": [ + "InternetGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InternetGatewayId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": null + }, + "AttachNetworkInterface": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "InstanceId": { + "type": "string" + }, + "DeviceIndex": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AttachmentId": { + "type": "string", + "locationName": "attachmentId" + } + } + } + }, + "AttachVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId", + "InstanceId", + "Device" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeId": { + "type": "string" + }, + "InstanceId": { + "type": "string" + }, + "Device": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "locationName": "attachment", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Device": { + "type": "string", + "locationName": "device" + }, + "State": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + } + }, + "AttachVpnGateway": { + "input": { + "type": "structure", + "required": [ + "VpnGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpnGatewayId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcAttachment": { + "type": "structure", + "locationName": "attachment", + "members": { + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + } + } + }, + "AuthorizeSecurityGroupEgress": { + "input": { + "type": "structure", + "required": [ + "GroupId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupId": { + "type": "string" + }, + "SourceSecurityGroupName": { + "type": "string" + }, + "SourceSecurityGroupOwnerId": { + "type": "string" + }, + "IpProtocol": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "CidrIp": { + "type": "string" + }, + "IpPermissions": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "IpProtocol": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "UserIdGroupPairs": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Groups", + "members": { + "UserId": { + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "GroupId": { + "type": "string" + } + } + } + }, + "IpRanges": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "CidrIp": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "output": null + }, + "AuthorizeSecurityGroupIngress": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupName": { + "type": "string" + }, + "GroupId": { + "type": "string" + }, + "SourceSecurityGroupName": { + "type": "string" + }, + "SourceSecurityGroupOwnerId": { + "type": "string" + }, + "IpProtocol": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "CidrIp": { + "type": "string" + }, + "IpPermissions": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "IpProtocol": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "UserIdGroupPairs": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Groups", + "members": { + "UserId": { + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "GroupId": { + "type": "string" + } + } + } + }, + "IpRanges": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "CidrIp": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "output": null + }, + "BundleInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": { + "type": "string" + }, + "Storage": { + "type": "structure", + "members": { + "S3": { + "type": "structure", + "members": { + "Bucket": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "AWSAccessKeyId": { + "type": "string" + }, + "UploadPolicy": { + "type": "blob" + }, + "UploadPolicySignature": { + "type": "string" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "BundleTask": { + "type": "structure", + "locationName": "bundleInstanceTask", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "BundleId": { + "type": "string", + "locationName": "bundleId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "StartTime": { + "type": "timestamp", + "locationName": "startTime" + }, + "UpdateTime": { + "type": "timestamp", + "locationName": "updateTime" + }, + "Storage": { + "type": "structure", + "locationName": "storage", + "members": { + "S3": { + "type": "structure", + "members": { + "Bucket": { + "type": "string", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "locationName": "prefix" + }, + "AWSAccessKeyId": { + "type": "string" + }, + "UploadPolicy": { + "type": "string", + "locationName": "uploadPolicy" + }, + "UploadPolicySignature": { + "type": "string", + "locationName": "uploadPolicySignature" + } + } + } + } + }, + "Progress": { + "type": "string", + "locationName": "progress" + }, + "BundleTaskError": { + "type": "structure", + "locationName": "error", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + } + } + } + } + } + }, + "CancelBundleTask": { + "input": { + "type": "structure", + "required": [ + "BundleId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "BundleId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "BundleTask": { + "type": "structure", + "locationName": "bundleInstanceTask", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "BundleId": { + "type": "string", + "locationName": "bundleId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "StartTime": { + "type": "timestamp", + "locationName": "startTime" + }, + "UpdateTime": { + "type": "timestamp", + "locationName": "updateTime" + }, + "Storage": { + "type": "structure", + "locationName": "storage", + "members": { + "S3": { + "type": "structure", + "members": { + "Bucket": { + "type": "string", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "locationName": "prefix" + }, + "AWSAccessKeyId": { + "type": "string" + }, + "UploadPolicy": { + "type": "string", + "locationName": "uploadPolicy" + }, + "UploadPolicySignature": { + "type": "string", + "locationName": "uploadPolicySignature" + } + } + } + } + }, + "Progress": { + "type": "string", + "locationName": "progress" + }, + "BundleTaskError": { + "type": "structure", + "locationName": "error", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + } + } + } + } + } + }, + "CancelConversionTask": { + "input": { + "type": "structure", + "required": [ + "ConversionTaskId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ConversionTaskId": { + "type": "string" + }, + "ReasonMessage": { + "type": "string" + } + } + }, + "output": null + }, + "CancelExportTask": { + "input": { + "type": "structure", + "required": [ + "ExportTaskId" + ], + "members": { + "ExportTaskId": { + "type": "string" + } + } + }, + "output": null + }, + "CancelReservedInstancesListing": { + "input": { + "type": "structure", + "required": [ + "ReservedInstancesListingId" + ], + "members": { + "ReservedInstancesListingId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "type": "list", + "locationName": "reservedInstancesListingsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservedInstancesListingId": { + "type": "string", + "locationName": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "type": "string", + "locationName": "reservedInstancesId" + }, + "CreateDate": { + "type": "timestamp", + "locationName": "createDate" + }, + "UpdateDate": { + "type": "timestamp", + "locationName": "updateDate" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "InstanceCounts": { + "type": "list", + "locationName": "instanceCounts", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "State": { + "type": "string", + "locationName": "state" + }, + "InstanceCount": { + "type": "integer", + "locationName": "instanceCount" + } + } + } + }, + "PriceSchedules": { + "type": "list", + "locationName": "priceSchedules", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Term": { + "type": "long", + "locationName": "term" + }, + "Price": { + "type": "double", + "locationName": "price" + }, + "CurrencyCode": { + "type": "string", + "locationName": "currencyCode" + }, + "Active": { + "type": "boolean", + "locationName": "active" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "ClientToken": { + "type": "string", + "locationName": "clientToken" + } + } + } + } + } + } + }, + "CancelSpotInstanceRequests": { + "input": { + "type": "structure", + "required": [ + "SpotInstanceRequestIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SpotInstanceRequestIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SpotInstanceRequestId" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "CancelledSpotInstanceRequests": { + "type": "list", + "locationName": "spotInstanceRequestSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "SpotInstanceRequestId": { + "type": "string", + "locationName": "spotInstanceRequestId" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + } + } + } + }, + "ConfirmProductInstance": { + "input": { + "type": "structure", + "required": [ + "ProductCode", + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ProductCode": { + "type": "string" + }, + "InstanceId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "OwnerId": { + "type": "string", + "locationName": "ownerId" + } + } + } + }, + "CopyImage": { + "input": { + "type": "structure", + "required": [ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SourceRegion": { + "type": "string" + }, + "SourceImageId": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "ClientToken": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageId": { + "type": "string", + "locationName": "imageId" + } + } + } + }, + "CopySnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceRegion", + "SourceSnapshotId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SourceRegion": { + "type": "string" + }, + "SourceSnapshotId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DestinationRegion": { + "type": "string" + }, + "PresignedUrl": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + } + } + } + }, + "CreateCustomerGateway": { + "input": { + "type": "structure", + "required": [ + "Type", + "PublicIp", + "BgpAsn" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Type": { + "type": "string" + }, + "PublicIp": { + "type": "string", + "locationName": "IpAddress" + }, + "BgpAsn": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "CustomerGateway": { + "type": "structure", + "locationName": "customerGateway", + "members": { + "CustomerGatewayId": { + "type": "string", + "locationName": "customerGatewayId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Type": { + "type": "string", + "locationName": "type" + }, + "IpAddress": { + "type": "string", + "locationName": "ipAddress" + }, + "BgpAsn": { + "type": "string", + "locationName": "bgpAsn" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "CreateDhcpOptions": { + "input": { + "type": "structure", + "required": [ + "DhcpConfigurations" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "DhcpConfigurations": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "DhcpConfiguration", + "members": { + "Key": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "DhcpOptions": { + "type": "structure", + "locationName": "dhcpOptions", + "members": { + "DhcpOptionsId": { + "type": "string", + "locationName": "dhcpOptionsId" + }, + "DhcpConfigurations": { + "type": "list", + "locationName": "dhcpConfigurationSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Values": { + "type": "list", + "locationName": "valueSet", + "member": { + "type": "string", + "locationName": "item" + } + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "CreateImage": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "Name" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "NoReboot": { + "type": "boolean" + }, + "BlockDeviceMappings": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "BlockDeviceMapping", + "members": { + "VirtualName": { + "type": "string" + }, + "DeviceName": { + "type": "string" + }, + "Ebs": { + "type": "structure", + "members": { + "SnapshotId": { + "type": "string" + }, + "VolumeSize": { + "type": "integer" + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "VolumeType": { + "type": "string" + }, + "Iops": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + } + } + }, + "NoDevice": { + "type": "string" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageId": { + "type": "string", + "locationName": "imageId" + } + } + } + }, + "CreateInstanceExportTask": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "Description": { + "type": "string" + }, + "InstanceId": { + "type": "string" + }, + "TargetEnvironment": { + "type": "string" + }, + "ExportToS3Task": { + "type": "structure", + "locationName": "ExportToS3", + "members": { + "DiskImageFormat": { + "type": "string" + }, + "ContainerFormat": { + "type": "string" + }, + "S3Bucket": { + "type": "string" + }, + "S3Prefix": { + "type": "string" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ExportTask": { + "type": "structure", + "locationName": "exportTask", + "members": { + "ExportTaskId": { + "type": "string", + "locationName": "exportTaskId" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "InstanceExportDetails": { + "type": "structure", + "locationName": "instanceExport", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "TargetEnvironment": { + "type": "string", + "locationName": "targetEnvironment" + } + } + }, + "ExportToS3Task": { + "type": "structure", + "locationName": "exportToS3", + "members": { + "DiskImageFormat": { + "type": "string", + "locationName": "diskImageFormat" + }, + "ContainerFormat": { + "type": "string", + "locationName": "containerFormat" + }, + "S3Bucket": { + "type": "string", + "locationName": "s3Bucket" + }, + "S3Key": { + "type": "string", + "locationName": "s3Key" + } + } + } + } + } + } + } + }, + "CreateInternetGateway": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InternetGateway": { + "type": "structure", + "locationName": "internetGateway", + "members": { + "InternetGatewayId": { + "type": "string", + "locationName": "internetGatewayId" + }, + "Attachments": { + "type": "list", + "locationName": "attachmentSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "CreateKeyPair": { + "input": { + "type": "structure", + "required": [ + "KeyName" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "KeyName": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyName": { + "type": "string", + "locationName": "keyName" + }, + "KeyFingerprint": { + "type": "string", + "locationName": "keyFingerprint" + }, + "KeyMaterial": { + "type": "string", + "locationName": "keyMaterial" + } + } + } + }, + "CreateNetworkAcl": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkAcl": { + "type": "structure", + "locationName": "networkAcl", + "members": { + "NetworkAclId": { + "type": "string", + "locationName": "networkAclId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "IsDefault": { + "type": "boolean", + "locationName": "default" + }, + "Entries": { + "type": "list", + "locationName": "entrySet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "RuleNumber": { + "type": "integer", + "locationName": "ruleNumber" + }, + "Protocol": { + "type": "string", + "locationName": "protocol" + }, + "RuleAction": { + "type": "string", + "locationName": "ruleAction" + }, + "Egress": { + "type": "boolean", + "locationName": "egress" + }, + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "IcmpTypeCode": { + "type": "structure", + "locationName": "icmpTypeCode", + "members": { + "Type": { + "type": "integer", + "locationName": "type" + }, + "Code": { + "type": "integer", + "locationName": "code" + } + } + }, + "PortRange": { + "type": "structure", + "locationName": "portRange", + "members": { + "From": { + "type": "integer", + "locationName": "from" + }, + "To": { + "type": "integer", + "locationName": "to" + } + } + } + } + } + }, + "Associations": { + "type": "list", + "locationName": "associationSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "NetworkAclAssociationId": { + "type": "string", + "locationName": "networkAclAssociationId" + }, + "NetworkAclId": { + "type": "string", + "locationName": "networkAclId" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "CreateNetworkAclEntry": { + "input": { + "type": "structure", + "required": [ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkAclId": { + "type": "string" + }, + "RuleNumber": { + "type": "integer" + }, + "Protocol": { + "type": "string" + }, + "RuleAction": { + "type": "string" + }, + "Egress": { + "type": "boolean" + }, + "CidrBlock": { + "type": "string" + }, + "IcmpTypeCode": { + "type": "structure", + "locationName": "Icmp", + "members": { + "Type": { + "type": "integer" + }, + "Code": { + "type": "integer" + } + } + }, + "PortRange": { + "type": "structure", + "members": { + "From": { + "type": "integer" + }, + "To": { + "type": "integer" + } + } + } + } + }, + "output": null + }, + "CreateNetworkInterface": { + "input": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "SubnetId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "PrivateIpAddress": { + "type": "string" + }, + "Groups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "PrivateIpAddresses": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string" + }, + "Primary": { + "type": "boolean" + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkInterface": { + "type": "structure", + "locationName": "networkInterface", + "members": { + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "RequesterId": { + "type": "string", + "locationName": "requesterId" + }, + "RequesterManaged": { + "type": "boolean", + "locationName": "requesterManaged" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "MacAddress": { + "type": "string", + "locationName": "macAddress" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "SourceDestCheck": { + "type": "boolean", + "locationName": "sourceDestCheck" + }, + "Groups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "locationName": "attachmentId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "locationName": "instanceOwnerId" + }, + "DeviceIndex": { + "type": "integer", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + }, + "Association": { + "type": "structure", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "locationName": "ipOwnerId" + }, + "AllocationId": { + "type": "string", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "locationName": "associationId" + } + } + }, + "TagSet": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "PrivateIpAddresses": { + "type": "list", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "Primary": { + "type": "boolean", + "locationName": "primary" + }, + "Association": { + "type": "structure", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "locationName": "ipOwnerId" + }, + "AllocationId": { + "type": "string", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "locationName": "associationId" + } + } + } + } + } + } + } + } + } + } + }, + "CreatePlacementGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "Strategy" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupName": { + "type": "string" + }, + "Strategy": { + "type": "string" + } + } + }, + "output": null + }, + "CreateReservedInstancesListing": { + "input": { + "type": "structure", + "required": [ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members": { + "ReservedInstancesId": { + "type": "string" + }, + "InstanceCount": { + "type": "integer" + }, + "PriceSchedules": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "Term": { + "type": "long" + }, + "Price": { + "type": "double" + }, + "CurrencyCode": { + "type": "string" + } + } + } + }, + "ClientToken": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "type": "list", + "locationName": "reservedInstancesListingsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservedInstancesListingId": { + "type": "string", + "locationName": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "type": "string", + "locationName": "reservedInstancesId" + }, + "CreateDate": { + "type": "timestamp", + "locationName": "createDate" + }, + "UpdateDate": { + "type": "timestamp", + "locationName": "updateDate" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "InstanceCounts": { + "type": "list", + "locationName": "instanceCounts", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "State": { + "type": "string", + "locationName": "state" + }, + "InstanceCount": { + "type": "integer", + "locationName": "instanceCount" + } + } + } + }, + "PriceSchedules": { + "type": "list", + "locationName": "priceSchedules", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Term": { + "type": "long", + "locationName": "term" + }, + "Price": { + "type": "double", + "locationName": "price" + }, + "CurrencyCode": { + "type": "string", + "locationName": "currencyCode" + }, + "Active": { + "type": "boolean", + "locationName": "active" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "ClientToken": { + "type": "string", + "locationName": "clientToken" + } + } + } + } + } + } + }, + "CreateRoute": { + "input": { + "type": "structure", + "required": [ + "RouteTableId", + "DestinationCidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "RouteTableId": { + "type": "string" + }, + "DestinationCidrBlock": { + "type": "string" + }, + "GatewayId": { + "type": "string" + }, + "InstanceId": { + "type": "string" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "VpcPeeringConnectionId": { + "type": "string" + } + } + }, + "output": null + }, + "CreateRouteTable": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "RouteTable": { + "type": "structure", + "locationName": "routeTable", + "members": { + "RouteTableId": { + "type": "string", + "locationName": "routeTableId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "Routes": { + "type": "list", + "locationName": "routeSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "DestinationCidrBlock": { + "type": "string", + "locationName": "destinationCidrBlock" + }, + "GatewayId": { + "type": "string", + "locationName": "gatewayId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "locationName": "instanceOwnerId" + }, + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "VpcPeeringConnectionId": { + "type": "string", + "locationName": "vpcPeeringConnectionId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Origin": { + "type": "string", + "locationName": "origin" + } + } + } + }, + "Associations": { + "type": "list", + "locationName": "associationSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "RouteTableAssociationId": { + "type": "string", + "locationName": "routeTableAssociationId" + }, + "RouteTableId": { + "type": "string", + "locationName": "routeTableId" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "Main": { + "type": "boolean", + "locationName": "main" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "PropagatingVgws": { + "type": "list", + "locationName": "propagatingVgwSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GatewayId": { + "type": "string", + "locationName": "gatewayId" + } + } + } + } + } + } + } + } + }, + "CreateSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "Description" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupName": { + "type": "string" + }, + "Description": { + "type": "string", + "locationName": "GroupDescription" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "CreateSnapshot": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeId": { + "type": "string" + }, + "Description": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "locationName": "snapshot", + "members": { + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "State": { + "type": "string", + "locationName": "status" + }, + "StartTime": { + "type": "timestamp", + "locationName": "startTime" + }, + "Progress": { + "type": "string", + "locationName": "progress" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "VolumeSize": { + "type": "integer", + "locationName": "volumeSize" + }, + "OwnerAlias": { + "type": "string", + "locationName": "ownerAlias" + }, + "Encrypted": { + "type": "boolean", + "locationName": "encrypted" + } + } + } + }, + "CreateSpotDatafeedSubscription": { + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Bucket": { + "type": "string" + }, + "Prefix": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "type": "structure", + "locationName": "spotDatafeedSubscription", + "members": { + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "Bucket": { + "type": "string", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "locationName": "prefix" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Fault": { + "type": "structure", + "locationName": "fault", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + } + } + } + } + } + }, + "CreateSubnet": { + "input": { + "type": "structure", + "required": [ + "VpcId", + "CidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcId": { + "type": "string" + }, + "CidrBlock": { + "type": "string" + }, + "AvailabilityZone": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "Subnet": { + "type": "structure", + "locationName": "subnet", + "members": { + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "AvailableIpAddressCount": { + "type": "integer", + "locationName": "availableIpAddressCount" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "DefaultForAz": { + "type": "boolean", + "locationName": "defaultForAz" + }, + "MapPublicIpOnLaunch": { + "type": "boolean", + "locationName": "mapPublicIpOnLaunch" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "CreateTags": { + "input": { + "type": "structure", + "required": [ + "Resources", + "Tags" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Resources": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ResourceId" + } + }, + "Tags": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Tag", + "members": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + } + } + } + }, + "output": null + }, + "CreateVolume": { + "input": { + "type": "structure", + "required": [ + "AvailabilityZone" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Size": { + "type": "integer" + }, + "SnapshotId": { + "type": "string" + }, + "AvailabilityZone": { + "type": "string" + }, + "VolumeType": { + "type": "string" + }, + "Iops": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "locationName": "volume", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "Size": { + "type": "integer", + "locationName": "size" + }, + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "State": { + "type": "string", + "locationName": "status" + }, + "CreateTime": { + "type": "timestamp", + "locationName": "createTime" + }, + "Attachments": { + "type": "list", + "locationName": "attachmentSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Device": { + "type": "string", + "locationName": "device" + }, + "State": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "VolumeType": { + "type": "string", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "locationName": "encrypted" + } + } + } + }, + "CreateVpc": { + "input": { + "type": "structure", + "required": [ + "CidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "CidrBlock": { + "type": "string" + }, + "InstanceTenancy": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "Vpc": { + "type": "structure", + "locationName": "vpc", + "members": { + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "DhcpOptionsId": { + "type": "string", + "locationName": "dhcpOptionsId" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "InstanceTenancy": { + "type": "string", + "locationName": "instanceTenancy" + }, + "IsDefault": { + "type": "boolean", + "locationName": "isDefault" + } + } + } + } + } + }, + "CreateVpcPeeringConnection": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcId": { + "type": "string" + }, + "PeerVpcId": { + "type": "string" + }, + "PeerOwnerId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "type": "structure", + "locationName": "vpcPeeringConnection", + "members": { + "AccepterVpcInfo": { + "type": "structure", + "locationName": "accepterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + } + } + }, + "ExpirationTime": { + "type": "timestamp", + "locationName": "expirationTime" + }, + "RequesterVpcInfo": { + "type": "structure", + "locationName": "requesterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + } + } + }, + "Status": { + "type": "structure", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "VpcPeeringConnectionId": { + "type": "string", + "locationName": "vpcPeeringConnectionId" + } + } + } + } + } + }, + "CreateVpnConnection": { + "input": { + "type": "structure", + "required": [ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Type": { + "type": "string" + }, + "CustomerGatewayId": { + "type": "string" + }, + "VpnGatewayId": { + "type": "string" + }, + "Options": { + "type": "structure", + "members": { + "StaticRoutesOnly": { + "type": "boolean" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnConnection": { + "type": "structure", + "locationName": "vpnConnection", + "members": { + "VpnConnectionId": { + "type": "string", + "locationName": "vpnConnectionId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "CustomerGatewayConfiguration": { + "type": "string", + "locationName": "customerGatewayConfiguration" + }, + "Type": { + "type": "string", + "locationName": "type" + }, + "CustomerGatewayId": { + "type": "string", + "locationName": "customerGatewayId" + }, + "VpnGatewayId": { + "type": "string", + "locationName": "vpnGatewayId" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "VgwTelemetry": { + "type": "list", + "locationName": "vgwTelemetry", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "OutsideIpAddress": { + "type": "string", + "locationName": "outsideIpAddress" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "LastStatusChange": { + "type": "timestamp", + "locationName": "lastStatusChange" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "AcceptedRouteCount": { + "type": "integer", + "locationName": "acceptedRouteCount" + } + } + } + }, + "Options": { + "type": "structure", + "locationName": "options", + "members": { + "StaticRoutesOnly": { + "type": "boolean", + "locationName": "staticRoutesOnly" + } + } + }, + "Routes": { + "type": "list", + "locationName": "routes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "DestinationCidrBlock": { + "type": "string", + "locationName": "destinationCidrBlock" + }, + "Source": { + "type": "string", + "locationName": "source" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + } + } + } + } + } + }, + "CreateVpnConnectionRoute": { + "input": { + "type": "structure", + "required": [ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members": { + "VpnConnectionId": { + "type": "string" + }, + "DestinationCidrBlock": { + "type": "string" + } + } + }, + "output": null + }, + "CreateVpnGateway": { + "input": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Type": { + "type": "string" + }, + "AvailabilityZone": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnGateway": { + "type": "structure", + "locationName": "vpnGateway", + "members": { + "VpnGatewayId": { + "type": "string", + "locationName": "vpnGatewayId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Type": { + "type": "string", + "locationName": "type" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "VpcAttachments": { + "type": "list", + "locationName": "attachments", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "DeleteCustomerGateway": { + "input": { + "type": "structure", + "required": [ + "CustomerGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "CustomerGatewayId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteDhcpOptions": { + "input": { + "type": "structure", + "required": [ + "DhcpOptionsId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "DhcpOptionsId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteInternetGateway": { + "input": { + "type": "structure", + "required": [ + "InternetGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InternetGatewayId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteKeyPair": { + "input": { + "type": "structure", + "required": [ + "KeyName" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "KeyName": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteNetworkAcl": { + "input": { + "type": "structure", + "required": [ + "NetworkAclId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkAclId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteNetworkAclEntry": { + "input": { + "type": "structure", + "required": [ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkAclId": { + "type": "string" + }, + "RuleNumber": { + "type": "integer" + }, + "Egress": { + "type": "boolean" + } + } + }, + "output": null + }, + "DeleteNetworkInterface": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkInterfaceId": { + "type": "string" + } + } + }, + "output": null + }, + "DeletePlacementGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupName": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteRoute": { + "input": { + "type": "structure", + "required": [ + "RouteTableId", + "DestinationCidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "RouteTableId": { + "type": "string" + }, + "DestinationCidrBlock": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteRouteTable": { + "input": { + "type": "structure", + "required": [ + "RouteTableId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "RouteTableId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteSecurityGroup": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupName": { + "type": "string" + }, + "GroupId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SnapshotId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteSpotDatafeedSubscription": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + } + } + }, + "output": null + }, + "DeleteSubnet": { + "input": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SubnetId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteTags": { + "input": { + "type": "structure", + "required": [ + "Resources" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Resources": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ResourceId" + } + }, + "Tags": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Tag", + "members": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + } + } + } + }, + "output": null + }, + "DeleteVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteVpc": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteVpcPeeringConnection": { + "input": { + "type": "structure", + "required": [ + "VpcPeeringConnectionId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcPeeringConnectionId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "type": "boolean", + "locationName": "return" + } + } + } + }, + "DeleteVpnConnection": { + "input": { + "type": "structure", + "required": [ + "VpnConnectionId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpnConnectionId": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteVpnConnectionRoute": { + "input": { + "type": "structure", + "required": [ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members": { + "VpnConnectionId": { + "type": "string" + }, + "DestinationCidrBlock": { + "type": "string" + } + } + }, + "output": null + }, + "DeleteVpnGateway": { + "input": { + "type": "structure", + "required": [ + "VpnGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpnGatewayId": { + "type": "string" + } + } + }, + "output": null + }, + "DeregisterImage": { + "input": { + "type": "structure", + "required": [ + "ImageId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ImageId": { + "type": "string" + } + } + }, + "output": null + }, + "DescribeAccountAttributes": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "AttributeNames": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "AttributeName" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "AccountAttributes": { + "type": "list", + "locationName": "accountAttributeSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "AttributeName": { + "type": "string", + "locationName": "attributeName" + }, + "AttributeValues": { + "type": "list", + "locationName": "attributeValueSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "AttributeValue": { + "type": "string", + "locationName": "attributeValue" + } + } + } + } + } + } + } + } + } + }, + "DescribeAddresses": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "PublicIps": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "PublicIp" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "AllocationIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "AllocationId" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Addresses": { + "type": "list", + "locationName": "addressesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "AllocationId": { + "type": "string", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "locationName": "associationId" + }, + "Domain": { + "type": "string", + "locationName": "domain" + }, + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "NetworkInterfaceOwnerId": { + "type": "string", + "locationName": "networkInterfaceOwnerId" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + } + } + } + } + } + } + }, + "DescribeAvailabilityZones": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "ZoneNames": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ZoneName" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "AvailabilityZones": { + "type": "list", + "locationName": "availabilityZoneInfo", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ZoneName": { + "type": "string", + "locationName": "zoneName" + }, + "State": { + "type": "string", + "locationName": "zoneState" + }, + "RegionName": { + "type": "string", + "locationName": "regionName" + }, + "Messages": { + "type": "list", + "locationName": "messageSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Message": { + "type": "string", + "locationName": "message" + } + } + } + } + } + } + } + } + } + }, + "DescribeBundleTasks": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "BundleIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "BundleId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "BundleTasks": { + "type": "list", + "locationName": "bundleInstanceTasksSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "BundleId": { + "type": "string", + "locationName": "bundleId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "StartTime": { + "type": "timestamp", + "locationName": "startTime" + }, + "UpdateTime": { + "type": "timestamp", + "locationName": "updateTime" + }, + "Storage": { + "type": "structure", + "locationName": "storage", + "members": { + "S3": { + "type": "structure", + "members": { + "Bucket": { + "type": "string", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "locationName": "prefix" + }, + "AWSAccessKeyId": { + "type": "string" + }, + "UploadPolicy": { + "type": "string", + "locationName": "uploadPolicy" + }, + "UploadPolicySignature": { + "type": "string", + "locationName": "uploadPolicySignature" + } + } + } + } + }, + "Progress": { + "type": "string", + "locationName": "progress" + }, + "BundleTaskError": { + "type": "structure", + "locationName": "error", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + } + } + } + } + } + } + }, + "DescribeConversionTasks": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "ConversionTaskIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ConversionTaskId" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ConversionTasks": { + "type": "list", + "locationName": "conversionTasks", + "member": { + "type": "structure", + "locationName": "item", + "required": [ + "ConversionTaskId", + "State" + ], + "members": { + "ConversionTaskId": { + "type": "string", + "locationName": "conversionTaskId" + }, + "ExpirationTime": { + "type": "string", + "locationName": "expirationTime" + }, + "ImportInstance": { + "type": "structure", + "locationName": "importInstance", + "required": [ + "Volumes" + ], + "members": { + "Volumes": { + "type": "list", + "locationName": "volumes", + "member": { + "type": "structure", + "locationName": "item", + "required": [ + "BytesConverted", + "AvailabilityZone", + "Status" + ], + "members": { + "BytesConverted": { + "type": "long", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Image": { + "type": "structure", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "locationName": "format" + }, + "Size": { + "type": "long", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "locationName": "size" + }, + "Id": { + "type": "string", + "locationName": "id" + } + } + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "Description": { + "type": "string", + "locationName": "description" + } + } + } + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Platform": { + "type": "string", + "locationName": "platform" + }, + "Description": { + "type": "string", + "locationName": "description" + } + } + }, + "ImportVolume": { + "type": "structure", + "locationName": "importVolume", + "required": [ + "BytesConverted", + "AvailabilityZone" + ], + "members": { + "BytesConverted": { + "type": "long", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "Image": { + "type": "structure", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "locationName": "format" + }, + "Size": { + "type": "long", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "locationName": "size" + }, + "Id": { + "type": "string", + "locationName": "id" + } + } + } + } + }, + "State": { + "type": "string", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + } + }, + "DescribeCustomerGateways": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "CustomerGatewayIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "CustomerGatewayId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "CustomerGateways": { + "type": "list", + "locationName": "customerGatewaySet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "CustomerGatewayId": { + "type": "string", + "locationName": "customerGatewayId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Type": { + "type": "string", + "locationName": "type" + }, + "IpAddress": { + "type": "string", + "locationName": "ipAddress" + }, + "BgpAsn": { + "type": "string", + "locationName": "bgpAsn" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + } + }, + "DescribeDhcpOptions": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "DhcpOptionsIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "DhcpOptionsId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "DhcpOptions": { + "type": "list", + "locationName": "dhcpOptionsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "DhcpOptionsId": { + "type": "string", + "locationName": "dhcpOptionsId" + }, + "DhcpConfigurations": { + "type": "list", + "locationName": "dhcpConfigurationSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Values": { + "type": "list", + "locationName": "valueSet", + "member": { + "type": "string", + "locationName": "item" + } + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + } + }, + "DescribeExportTasks": { + "input": { + "type": "structure", + "members": { + "ExportTaskIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ExportTaskId" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ExportTasks": { + "type": "list", + "locationName": "exportTaskSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ExportTaskId": { + "type": "string", + "locationName": "exportTaskId" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "InstanceExportDetails": { + "type": "structure", + "locationName": "instanceExport", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "TargetEnvironment": { + "type": "string", + "locationName": "targetEnvironment" + } + } + }, + "ExportToS3Task": { + "type": "structure", + "locationName": "exportToS3", + "members": { + "DiskImageFormat": { + "type": "string", + "locationName": "diskImageFormat" + }, + "ContainerFormat": { + "type": "string", + "locationName": "containerFormat" + }, + "S3Bucket": { + "type": "string", + "locationName": "s3Bucket" + }, + "S3Key": { + "type": "string", + "locationName": "s3Key" + } + } + } + } + } + } + } + } + }, + "DescribeImageAttribute": { + "input": { + "type": "structure", + "required": [ + "ImageId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ImageId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "locationName": "imageAttribute", + "members": { + "ImageId": { + "type": "string", + "locationName": "imageId" + }, + "LaunchPermissions": { + "type": "list", + "locationName": "launchPermission", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "UserId": { + "type": "string", + "locationName": "userId" + }, + "Group": { + "type": "string", + "locationName": "group" + } + } + } + }, + "ProductCodes": { + "type": "list", + "locationName": "productCodes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "locationName": "type" + } + } + } + }, + "KernelId": { + "type": "structure", + "locationName": "kernel", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "RamdiskId": { + "type": "structure", + "locationName": "ramdisk", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "Description": { + "type": "structure", + "locationName": "description", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "SriovNetSupport": { + "type": "structure", + "locationName": "sriovNetSupport", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "BlockDeviceMappings": { + "type": "list", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VirtualName": { + "type": "string", + "locationName": "virtualName" + }, + "DeviceName": { + "type": "string", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "locationName": "ebs", + "members": { + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "VolumeSize": { + "type": "integer", + "locationName": "volumeSize" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + }, + "VolumeType": { + "type": "string", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "locationName": "encrypted" + } + } + }, + "NoDevice": { + "type": "string", + "locationName": "noDevice" + } + } + } + } + } + } + }, + "DescribeImages": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "ImageIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ImageId" + } + }, + "Owners": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Owner" + } + }, + "ExecutableUsers": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ExecutableBy" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Images": { + "type": "list", + "locationName": "imagesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ImageId": { + "type": "string", + "locationName": "imageId" + }, + "ImageLocation": { + "type": "string", + "locationName": "imageLocation" + }, + "State": { + "type": "string", + "locationName": "imageState" + }, + "OwnerId": { + "type": "string", + "locationName": "imageOwnerId" + }, + "Public": { + "type": "boolean", + "locationName": "isPublic" + }, + "ProductCodes": { + "type": "list", + "locationName": "productCodes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "locationName": "type" + } + } + } + }, + "Architecture": { + "type": "string", + "locationName": "architecture" + }, + "ImageType": { + "type": "string", + "locationName": "imageType" + }, + "KernelId": { + "type": "string", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "locationName": "ramdiskId" + }, + "Platform": { + "type": "string", + "locationName": "platform" + }, + "SriovNetSupport": { + "type": "string", + "locationName": "sriovNetSupport" + }, + "StateReason": { + "type": "structure", + "locationName": "stateReason", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "ImageOwnerAlias": { + "type": "string", + "locationName": "imageOwnerAlias" + }, + "Name": { + "type": "string", + "locationName": "name" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "RootDeviceType": { + "type": "string", + "locationName": "rootDeviceType" + }, + "RootDeviceName": { + "type": "string", + "locationName": "rootDeviceName" + }, + "BlockDeviceMappings": { + "type": "list", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VirtualName": { + "type": "string", + "locationName": "virtualName" + }, + "DeviceName": { + "type": "string", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "locationName": "ebs", + "members": { + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "VolumeSize": { + "type": "integer", + "locationName": "volumeSize" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + }, + "VolumeType": { + "type": "string", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "locationName": "encrypted" + } + } + }, + "NoDevice": { + "type": "string", + "locationName": "noDevice" + } + } + } + }, + "VirtualizationType": { + "type": "string", + "locationName": "virtualizationType" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "Hypervisor": { + "type": "string", + "locationName": "hypervisor" + } + } + } + } + } + } + }, + "DescribeInstanceAttribute": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "InstanceType": { + "type": "structure", + "locationName": "instanceType", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "KernelId": { + "type": "structure", + "locationName": "kernel", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "RamdiskId": { + "type": "structure", + "locationName": "ramdisk", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "UserData": { + "type": "structure", + "locationName": "userData", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "DisableApiTermination": { + "type": "structure", + "locationName": "disableApiTermination", + "members": { + "Value": { + "type": "boolean", + "locationName": "value" + } + } + }, + "InstanceInitiatedShutdownBehavior": { + "type": "structure", + "locationName": "instanceInitiatedShutdownBehavior", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "RootDeviceName": { + "type": "structure", + "locationName": "rootDeviceName", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "BlockDeviceMappings": { + "type": "list", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "DeviceName": { + "type": "string", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "locationName": "ebs", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + } + } + } + }, + "ProductCodes": { + "type": "list", + "locationName": "productCodes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "locationName": "type" + } + } + } + }, + "EbsOptimized": { + "type": "structure", + "locationName": "ebsOptimized", + "members": { + "Value": { + "type": "boolean", + "locationName": "value" + } + } + }, + "SriovNetSupport": { + "type": "structure", + "locationName": "sriovNetSupport", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "SourceDestCheck": { + "type": "structure", + "locationName": "sourceDestCheck", + "members": { + "Value": { + "type": "boolean", + "locationName": "value" + } + } + } + } + } + }, + "DescribeInstanceStatus": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "NextToken": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "IncludeAllInstances": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceStatuses": { + "type": "list", + "locationName": "instanceStatusSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Events": { + "type": "list", + "locationName": "eventsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "NotBefore": { + "type": "timestamp", + "locationName": "notBefore" + }, + "NotAfter": { + "type": "timestamp", + "locationName": "notAfter" + } + } + } + }, + "InstanceState": { + "type": "structure", + "locationName": "instanceState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + }, + "SystemStatus": { + "type": "structure", + "locationName": "systemStatus", + "members": { + "Status": { + "type": "string", + "locationName": "status" + }, + "Details": { + "type": "list", + "locationName": "details", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Name": { + "type": "string", + "locationName": "name" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "ImpairedSince": { + "type": "timestamp", + "locationName": "impairedSince" + } + } + } + } + } + }, + "InstanceStatus": { + "type": "structure", + "locationName": "instanceStatus", + "members": { + "Status": { + "type": "string", + "locationName": "status" + }, + "Details": { + "type": "list", + "locationName": "details", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Name": { + "type": "string", + "locationName": "name" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "ImpairedSince": { + "type": "timestamp", + "locationName": "impairedSince" + } + } + } + } + } + } + } + } + }, + "NextToken": { + "type": "string", + "locationName": "nextToken" + } + } + } + }, + "DescribeInstances": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "NextToken": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Reservations": { + "type": "list", + "locationName": "reservationSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservationId": { + "type": "string", + "locationName": "reservationId" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "RequesterId": { + "type": "string", + "locationName": "requesterId" + }, + "Groups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "Instances": { + "type": "list", + "locationName": "instancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "ImageId": { + "type": "string", + "locationName": "imageId" + }, + "State": { + "type": "structure", + "locationName": "instanceState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "PublicDnsName": { + "type": "string", + "locationName": "dnsName" + }, + "StateTransitionReason": { + "type": "string", + "locationName": "reason" + }, + "KeyName": { + "type": "string", + "locationName": "keyName" + }, + "AmiLaunchIndex": { + "type": "integer", + "locationName": "amiLaunchIndex" + }, + "ProductCodes": { + "type": "list", + "locationName": "productCodes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "locationName": "type" + } + } + } + }, + "InstanceType": { + "type": "string", + "locationName": "instanceType" + }, + "LaunchTime": { + "type": "timestamp", + "locationName": "launchTime" + }, + "Placement": { + "type": "structure", + "locationName": "placement", + "members": { + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "Tenancy": { + "type": "string", + "locationName": "tenancy" + } + } + }, + "KernelId": { + "type": "string", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "locationName": "ramdiskId" + }, + "Platform": { + "type": "string", + "locationName": "platform" + }, + "Monitoring": { + "type": "structure", + "locationName": "monitoring", + "members": { + "State": { + "type": "string", + "locationName": "state" + } + } + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PublicIpAddress": { + "type": "string", + "locationName": "ipAddress" + }, + "StateReason": { + "type": "structure", + "locationName": "stateReason", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "Architecture": { + "type": "string", + "locationName": "architecture" + }, + "RootDeviceType": { + "type": "string", + "locationName": "rootDeviceType" + }, + "RootDeviceName": { + "type": "string", + "locationName": "rootDeviceName" + }, + "BlockDeviceMappings": { + "type": "list", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "DeviceName": { + "type": "string", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "locationName": "ebs", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + } + } + } + }, + "VirtualizationType": { + "type": "string", + "locationName": "virtualizationType" + }, + "InstanceLifecycle": { + "type": "string", + "locationName": "instanceLifecycle" + }, + "SpotInstanceRequestId": { + "type": "string", + "locationName": "spotInstanceRequestId" + }, + "ClientToken": { + "type": "string", + "locationName": "clientToken" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "SecurityGroups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "SourceDestCheck": { + "type": "boolean", + "locationName": "sourceDestCheck" + }, + "Hypervisor": { + "type": "string", + "locationName": "hypervisor" + }, + "NetworkInterfaces": { + "type": "list", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "SourceDestCheck": { + "type": "boolean", + "locationName": "sourceDestCheck" + }, + "Groups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "locationName": "attachmentId" + }, + "DeviceIndex": { + "type": "integer", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + }, + "Association": { + "type": "structure", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "locationName": "ipOwnerId" + } + } + }, + "PrivateIpAddresses": { + "type": "list", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "Primary": { + "type": "boolean", + "locationName": "primary" + }, + "Association": { + "type": "structure", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "locationName": "ipOwnerId" + } + } + } + } + } + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "locationName": "iamInstanceProfile", + "members": { + "Arn": { + "type": "string", + "locationName": "arn" + }, + "Id": { + "type": "string", + "locationName": "id" + } + } + }, + "EbsOptimized": { + "type": "boolean", + "locationName": "ebsOptimized" + }, + "SriovNetSupport": { + "type": "string", + "locationName": "sriovNetSupport" + } + } + } + } + } + } + }, + "NextToken": { + "type": "string", + "locationName": "nextToken" + } + } + } + }, + "DescribeInternetGateways": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "InternetGatewayIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InternetGatewayId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "InternetGateways": { + "type": "list", + "locationName": "internetGatewaySet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InternetGatewayId": { + "type": "string", + "locationName": "internetGatewayId" + }, + "Attachments": { + "type": "list", + "locationName": "attachmentSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + } + }, + "DescribeKeyPairs": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "KeyNames": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "KeyName" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyPairs": { + "type": "list", + "locationName": "keySet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "KeyName": { + "type": "string", + "locationName": "keyName" + }, + "KeyFingerprint": { + "type": "string", + "locationName": "keyFingerprint" + } + } + } + } + } + } + }, + "DescribeNetworkAcls": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkAclIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "NetworkAclId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkAcls": { + "type": "list", + "locationName": "networkAclSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "NetworkAclId": { + "type": "string", + "locationName": "networkAclId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "IsDefault": { + "type": "boolean", + "locationName": "default" + }, + "Entries": { + "type": "list", + "locationName": "entrySet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "RuleNumber": { + "type": "integer", + "locationName": "ruleNumber" + }, + "Protocol": { + "type": "string", + "locationName": "protocol" + }, + "RuleAction": { + "type": "string", + "locationName": "ruleAction" + }, + "Egress": { + "type": "boolean", + "locationName": "egress" + }, + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "IcmpTypeCode": { + "type": "structure", + "locationName": "icmpTypeCode", + "members": { + "Type": { + "type": "integer", + "locationName": "type" + }, + "Code": { + "type": "integer", + "locationName": "code" + } + } + }, + "PortRange": { + "type": "structure", + "locationName": "portRange", + "members": { + "From": { + "type": "integer", + "locationName": "from" + }, + "To": { + "type": "integer", + "locationName": "to" + } + } + } + } + } + }, + "Associations": { + "type": "list", + "locationName": "associationSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "NetworkAclAssociationId": { + "type": "string", + "locationName": "networkAclAssociationId" + }, + "NetworkAclId": { + "type": "string", + "locationName": "networkAclId" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + } + }, + "DescribeNetworkInterfaceAttribute": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "Description": { + "type": "structure", + "locationName": "description", + "members": { + "Value": { + "type": "string", + "locationName": "value" + } + } + }, + "SourceDestCheck": { + "type": "structure", + "locationName": "sourceDestCheck", + "members": { + "Value": { + "type": "boolean", + "locationName": "value" + } + } + }, + "Groups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "locationName": "attachmentId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "locationName": "instanceOwnerId" + }, + "DeviceIndex": { + "type": "integer", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + } + } + } + }, + "DescribeNetworkInterfaces": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkInterfaceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "NetworkInterfaceId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "NetworkInterfaces": { + "type": "list", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "RequesterId": { + "type": "string", + "locationName": "requesterId" + }, + "RequesterManaged": { + "type": "boolean", + "locationName": "requesterManaged" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "MacAddress": { + "type": "string", + "locationName": "macAddress" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "SourceDestCheck": { + "type": "boolean", + "locationName": "sourceDestCheck" + }, + "Groups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "locationName": "attachmentId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "locationName": "instanceOwnerId" + }, + "DeviceIndex": { + "type": "integer", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + }, + "Association": { + "type": "structure", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "locationName": "ipOwnerId" + }, + "AllocationId": { + "type": "string", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "locationName": "associationId" + } + } + }, + "TagSet": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "PrivateIpAddresses": { + "type": "list", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "Primary": { + "type": "boolean", + "locationName": "primary" + }, + "Association": { + "type": "structure", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "locationName": "ipOwnerId" + }, + "AllocationId": { + "type": "string", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "locationName": "associationId" + } + } + } + } + } + } + } + } + } + } + } + }, + "DescribePlacementGroups": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupNames": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "GroupName" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "PlacementGroups": { + "type": "list", + "locationName": "placementGroupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "Strategy": { + "type": "string", + "locationName": "strategy" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + } + } + } + }, + "DescribeRegions": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "RegionNames": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "RegionName" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Regions": { + "type": "list", + "locationName": "regionInfo", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "RegionName": { + "type": "string", + "locationName": "regionName" + }, + "Endpoint": { + "type": "string", + "locationName": "regionEndpoint" + } + } + } + } + } + } + }, + "DescribeReservedInstances": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "ReservedInstancesIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ReservedInstancesId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "OfferingType": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstances": { + "type": "list", + "locationName": "reservedInstancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservedInstancesId": { + "type": "string", + "locationName": "reservedInstancesId" + }, + "InstanceType": { + "type": "string", + "locationName": "instanceType" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Start": { + "type": "timestamp", + "locationName": "start" + }, + "End": { + "type": "timestamp", + "locationName": "end" + }, + "Duration": { + "type": "long", + "locationName": "duration" + }, + "UsagePrice": { + "type": "float", + "locationName": "usagePrice" + }, + "FixedPrice": { + "type": "float", + "locationName": "fixedPrice" + }, + "InstanceCount": { + "type": "integer", + "locationName": "instanceCount" + }, + "ProductDescription": { + "type": "string", + "locationName": "productDescription" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "InstanceTenancy": { + "type": "string", + "locationName": "instanceTenancy" + }, + "CurrencyCode": { + "type": "string", + "locationName": "currencyCode" + }, + "OfferingType": { + "type": "string", + "locationName": "offeringType" + }, + "RecurringCharges": { + "type": "list", + "locationName": "recurringCharges", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Frequency": { + "type": "string", + "locationName": "frequency" + }, + "Amount": { + "type": "double", + "locationName": "amount" + } + } + } + } + } + } + } + } + } + }, + "DescribeReservedInstancesListings": { + "input": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "type": "string" + }, + "ReservedInstancesListingId": { + "type": "string" + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "type": "list", + "locationName": "reservedInstancesListingsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservedInstancesListingId": { + "type": "string", + "locationName": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "type": "string", + "locationName": "reservedInstancesId" + }, + "CreateDate": { + "type": "timestamp", + "locationName": "createDate" + }, + "UpdateDate": { + "type": "timestamp", + "locationName": "updateDate" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "InstanceCounts": { + "type": "list", + "locationName": "instanceCounts", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "State": { + "type": "string", + "locationName": "state" + }, + "InstanceCount": { + "type": "integer", + "locationName": "instanceCount" + } + } + } + }, + "PriceSchedules": { + "type": "list", + "locationName": "priceSchedules", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Term": { + "type": "long", + "locationName": "term" + }, + "Price": { + "type": "double", + "locationName": "price" + }, + "CurrencyCode": { + "type": "string", + "locationName": "currencyCode" + }, + "Active": { + "type": "boolean", + "locationName": "active" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "ClientToken": { + "type": "string", + "locationName": "clientToken" + } + } + } + } + } + } + }, + "DescribeReservedInstancesModifications": { + "input": { + "type": "structure", + "members": { + "ReservedInstancesModificationIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ReservedInstancesModificationId" + } + }, + "NextToken": { + "type": "string" + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesModifications": { + "type": "list", + "locationName": "reservedInstancesModificationsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservedInstancesModificationId": { + "type": "string", + "locationName": "reservedInstancesModificationId" + }, + "ReservedInstancesIds": { + "type": "list", + "locationName": "reservedInstancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservedInstancesId": { + "type": "string", + "locationName": "reservedInstancesId" + } + } + } + }, + "ModificationResults": { + "type": "list", + "locationName": "modificationResultSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservedInstancesId": { + "type": "string", + "locationName": "reservedInstancesId" + }, + "TargetConfiguration": { + "type": "structure", + "locationName": "targetConfiguration", + "members": { + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Platform": { + "type": "string", + "locationName": "platform" + }, + "InstanceCount": { + "type": "integer", + "locationName": "instanceCount" + }, + "InstanceType": { + "type": "string", + "locationName": "instanceType" + } + } + } + } + } + }, + "CreateDate": { + "type": "timestamp", + "locationName": "createDate" + }, + "UpdateDate": { + "type": "timestamp", + "locationName": "updateDate" + }, + "EffectiveDate": { + "type": "timestamp", + "locationName": "effectiveDate" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "ClientToken": { + "type": "string", + "locationName": "clientToken" + } + } + } + }, + "NextToken": { + "type": "string", + "locationName": "nextToken" + } + } + } + }, + "DescribeReservedInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "ReservedInstancesOfferingIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ReservedInstancesOfferingId" + } + }, + "InstanceType": { + "type": "string" + }, + "AvailabilityZone": { + "type": "string" + }, + "ProductDescription": { + "type": "string" + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "InstanceTenancy": { + "type": "string" + }, + "OfferingType": { + "type": "string" + }, + "NextToken": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "IncludeMarketplace": { + "type": "boolean" + }, + "MinDuration": { + "type": "long" + }, + "MaxDuration": { + "type": "long" + }, + "MaxInstanceCount": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesOfferings": { + "type": "list", + "locationName": "reservedInstancesOfferingsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ReservedInstancesOfferingId": { + "type": "string", + "locationName": "reservedInstancesOfferingId" + }, + "InstanceType": { + "type": "string", + "locationName": "instanceType" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Duration": { + "type": "long", + "locationName": "duration" + }, + "UsagePrice": { + "type": "float", + "locationName": "usagePrice" + }, + "FixedPrice": { + "type": "float", + "locationName": "fixedPrice" + }, + "ProductDescription": { + "type": "string", + "locationName": "productDescription" + }, + "InstanceTenancy": { + "type": "string", + "locationName": "instanceTenancy" + }, + "CurrencyCode": { + "type": "string", + "locationName": "currencyCode" + }, + "OfferingType": { + "type": "string", + "locationName": "offeringType" + }, + "RecurringCharges": { + "type": "list", + "locationName": "recurringCharges", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Frequency": { + "type": "string", + "locationName": "frequency" + }, + "Amount": { + "type": "double", + "locationName": "amount" + } + } + } + }, + "Marketplace": { + "type": "boolean", + "locationName": "marketplace" + }, + "PricingDetails": { + "type": "list", + "locationName": "pricingDetailsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Price": { + "type": "double", + "locationName": "price" + }, + "Count": { + "type": "integer", + "locationName": "count" + } + } + } + } + } + } + }, + "NextToken": { + "type": "string", + "locationName": "nextToken" + } + } + } + }, + "DescribeRouteTables": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "RouteTableIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "RouteTableId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "RouteTables": { + "type": "list", + "locationName": "routeTableSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "RouteTableId": { + "type": "string", + "locationName": "routeTableId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "Routes": { + "type": "list", + "locationName": "routeSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "DestinationCidrBlock": { + "type": "string", + "locationName": "destinationCidrBlock" + }, + "GatewayId": { + "type": "string", + "locationName": "gatewayId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "locationName": "instanceOwnerId" + }, + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "VpcPeeringConnectionId": { + "type": "string", + "locationName": "vpcPeeringConnectionId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Origin": { + "type": "string", + "locationName": "origin" + } + } + } + }, + "Associations": { + "type": "list", + "locationName": "associationSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "RouteTableAssociationId": { + "type": "string", + "locationName": "routeTableAssociationId" + }, + "RouteTableId": { + "type": "string", + "locationName": "routeTableId" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "Main": { + "type": "boolean", + "locationName": "main" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "PropagatingVgws": { + "type": "list", + "locationName": "propagatingVgwSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GatewayId": { + "type": "string", + "locationName": "gatewayId" + } + } + } + } + } + } + } + } + } + }, + "DescribeSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupNames": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "GroupName" + } + }, + "GroupIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "GroupId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SecurityGroups": { + "type": "list", + "locationName": "securityGroupInfo", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + }, + "Description": { + "type": "string", + "locationName": "groupDescription" + }, + "IpPermissions": { + "type": "list", + "locationName": "ipPermissions", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "IpProtocol": { + "type": "string", + "locationName": "ipProtocol" + }, + "FromPort": { + "type": "integer", + "locationName": "fromPort" + }, + "ToPort": { + "type": "integer", + "locationName": "toPort" + }, + "UserIdGroupPairs": { + "type": "list", + "locationName": "groups", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "UserId": { + "type": "string", + "locationName": "userId" + }, + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "IpRanges": { + "type": "list", + "locationName": "ipRanges", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "CidrIp": { + "type": "string", + "locationName": "cidrIp" + } + } + } + } + } + } + }, + "IpPermissionsEgress": { + "type": "list", + "locationName": "ipPermissionsEgress", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "IpProtocol": { + "type": "string", + "locationName": "ipProtocol" + }, + "FromPort": { + "type": "integer", + "locationName": "fromPort" + }, + "ToPort": { + "type": "integer", + "locationName": "toPort" + }, + "UserIdGroupPairs": { + "type": "list", + "locationName": "groups", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "UserId": { + "type": "string", + "locationName": "userId" + }, + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "IpRanges": { + "type": "list", + "locationName": "ipRanges", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "CidrIp": { + "type": "string", + "locationName": "cidrIp" + } + } + } + } + } + } + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + } + }, + "DescribeSnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "SnapshotId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SnapshotId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "CreateVolumePermissions": { + "type": "list", + "locationName": "createVolumePermission", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "UserId": { + "type": "string", + "locationName": "userId" + }, + "Group": { + "type": "string", + "locationName": "group" + } + } + } + }, + "ProductCodes": { + "type": "list", + "locationName": "productCodes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "locationName": "type" + } + } + } + } + } + } + }, + "DescribeSnapshots": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "SnapshotIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SnapshotId" + } + }, + "OwnerIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Owner" + } + }, + "RestorableByUserIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "RestorableBy" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Snapshots": { + "type": "list", + "locationName": "snapshotSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "State": { + "type": "string", + "locationName": "status" + }, + "StartTime": { + "type": "timestamp", + "locationName": "startTime" + }, + "Progress": { + "type": "string", + "locationName": "progress" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "VolumeSize": { + "type": "integer", + "locationName": "volumeSize" + }, + "OwnerAlias": { + "type": "string", + "locationName": "ownerAlias" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "Encrypted": { + "type": "boolean", + "locationName": "encrypted" + } + } + } + } + } + } + }, + "DescribeSpotDatafeedSubscription": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "type": "structure", + "locationName": "spotDatafeedSubscription", + "members": { + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "Bucket": { + "type": "string", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "locationName": "prefix" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Fault": { + "type": "structure", + "locationName": "fault", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + } + } + } + } + } + }, + "DescribeSpotInstanceRequests": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "SpotInstanceRequestIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SpotInstanceRequestId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotInstanceRequests": { + "type": "list", + "locationName": "spotInstanceRequestSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "SpotInstanceRequestId": { + "type": "string", + "locationName": "spotInstanceRequestId" + }, + "SpotPrice": { + "type": "string", + "locationName": "spotPrice" + }, + "Type": { + "type": "string", + "locationName": "type" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Fault": { + "type": "structure", + "locationName": "fault", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "Status": { + "type": "structure", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "UpdateTime": { + "type": "timestamp", + "locationName": "updateTime" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "ValidFrom": { + "type": "timestamp", + "locationName": "validFrom" + }, + "ValidUntil": { + "type": "timestamp", + "locationName": "validUntil" + }, + "LaunchGroup": { + "type": "string", + "locationName": "launchGroup" + }, + "AvailabilityZoneGroup": { + "type": "string", + "locationName": "availabilityZoneGroup" + }, + "LaunchSpecification": { + "type": "structure", + "locationName": "launchSpecification", + "members": { + "ImageId": { + "type": "string", + "locationName": "imageId" + }, + "KeyName": { + "type": "string", + "locationName": "keyName" + }, + "SecurityGroups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "UserData": { + "type": "string", + "locationName": "userData" + }, + "AddressingType": { + "type": "string", + "locationName": "addressingType" + }, + "InstanceType": { + "type": "string", + "locationName": "instanceType" + }, + "Placement": { + "type": "structure", + "locationName": "placement", + "members": { + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "GroupName": { + "type": "string", + "locationName": "groupName" + } + } + }, + "KernelId": { + "type": "string", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "locationName": "ramdiskId" + }, + "BlockDeviceMappings": { + "type": "list", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VirtualName": { + "type": "string", + "locationName": "virtualName" + }, + "DeviceName": { + "type": "string", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "locationName": "ebs", + "members": { + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "VolumeSize": { + "type": "integer", + "locationName": "volumeSize" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + }, + "VolumeType": { + "type": "string", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "locationName": "encrypted" + } + } + }, + "NoDevice": { + "type": "string", + "locationName": "noDevice" + } + } + } + }, + "MonitoringEnabled": { + "type": "boolean", + "locationName": "monitoringEnabled" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "NetworkInterfaces": { + "type": "list", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "DeviceIndex": { + "type": "integer", + "locationName": "deviceIndex" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "Groups": { + "type": "list", + "locationName": "SecurityGroupId", + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + }, + "PrivateIpAddresses": { + "type": "list", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "locationName": "item", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "Primary": { + "type": "boolean", + "locationName": "primary" + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer", + "locationName": "secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress": { + "type": "boolean", + "locationName": "associatePublicIpAddress" + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "locationName": "iamInstanceProfile", + "members": { + "Arn": { + "type": "string", + "locationName": "arn" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + }, + "EbsOptimized": { + "type": "boolean", + "locationName": "ebsOptimized" + } + } + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "CreateTime": { + "type": "timestamp", + "locationName": "createTime" + }, + "ProductDescription": { + "type": "string", + "locationName": "productDescription" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "LaunchedAvailabilityZone": { + "type": "string", + "locationName": "launchedAvailabilityZone" + } + } + } + } + } + } + }, + "DescribeSpotPriceHistory": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "InstanceTypes": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceType" + } + }, + "ProductDescriptions": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ProductDescription" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "AvailabilityZone": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotPriceHistory": { + "type": "list", + "locationName": "spotPriceHistorySet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceType": { + "type": "string", + "locationName": "instanceType" + }, + "ProductDescription": { + "type": "string", + "locationName": "productDescription" + }, + "SpotPrice": { + "type": "string", + "locationName": "spotPrice" + }, + "Timestamp": { + "type": "timestamp", + "locationName": "timestamp" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + } + } + } + }, + "NextToken": { + "type": "string", + "locationName": "nextToken" + } + } + } + }, + "DescribeSubnets": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "SubnetIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SubnetId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Subnets": { + "type": "list", + "locationName": "subnetSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "AvailableIpAddressCount": { + "type": "integer", + "locationName": "availableIpAddressCount" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "DefaultForAz": { + "type": "boolean", + "locationName": "defaultForAz" + }, + "MapPublicIpOnLaunch": { + "type": "boolean", + "locationName": "mapPublicIpOnLaunch" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ResourceId": { + "type": "string", + "locationName": "resourceId" + }, + "ResourceType": { + "type": "string", + "locationName": "resourceType" + }, + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "NextToken": { + "type": "string", + "locationName": "nextToken" + } + } + } + }, + "DescribeVolumeAttribute": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "AutoEnableIO": { + "type": "structure", + "locationName": "autoEnableIO", + "members": { + "Value": { + "type": "boolean", + "locationName": "value" + } + } + }, + "ProductCodes": { + "type": "list", + "locationName": "productCodes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "locationName": "type" + } + } + } + } + } + } + }, + "DescribeVolumeStatus": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "VolumeId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + }, + "NextToken": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "VolumeStatuses": { + "type": "list", + "locationName": "volumeStatusSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "VolumeStatus": { + "type": "structure", + "locationName": "volumeStatus", + "members": { + "Status": { + "type": "string", + "locationName": "status" + }, + "Details": { + "type": "list", + "locationName": "details", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Name": { + "type": "string", + "locationName": "name" + }, + "Status": { + "type": "string", + "locationName": "status" + } + } + } + } + } + }, + "Events": { + "type": "list", + "locationName": "eventsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "EventType": { + "type": "string", + "locationName": "eventType" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "NotBefore": { + "type": "timestamp", + "locationName": "notBefore" + }, + "NotAfter": { + "type": "timestamp", + "locationName": "notAfter" + }, + "EventId": { + "type": "string", + "locationName": "eventId" + } + } + } + }, + "Actions": { + "type": "list", + "locationName": "actionsSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "EventType": { + "type": "string", + "locationName": "eventType" + }, + "EventId": { + "type": "string", + "locationName": "eventId" + } + } + } + } + } + } + }, + "NextToken": { + "type": "string", + "locationName": "nextToken" + } + } + } + }, + "DescribeVolumes": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "VolumeId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Volumes": { + "type": "list", + "locationName": "volumeSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "Size": { + "type": "integer", + "locationName": "size" + }, + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "State": { + "type": "string", + "locationName": "status" + }, + "CreateTime": { + "type": "timestamp", + "locationName": "createTime" + }, + "Attachments": { + "type": "list", + "locationName": "attachmentSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Device": { + "type": "string", + "locationName": "device" + }, + "State": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "VolumeType": { + "type": "string", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "locationName": "encrypted" + } + } + } + } + } + } + }, + "DescribeVpcAttribute": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "EnableDnsSupport": { + "type": "structure", + "locationName": "enableDnsSupport", + "members": { + "Value": { + "type": "boolean", + "locationName": "value" + } + } + }, + "EnableDnsHostnames": { + "type": "structure", + "locationName": "enableDnsHostnames", + "members": { + "Value": { + "type": "boolean", + "locationName": "value" + } + } + } + } + } + }, + "DescribeVpcPeeringConnections": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcPeeringConnectionIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "VpcPeeringConnectionId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "VpcPeeringConnections": { + "type": "list", + "locationName": "vpcPeeringConnectionSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "AccepterVpcInfo": { + "type": "structure", + "locationName": "accepterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + } + } + }, + "ExpirationTime": { + "type": "timestamp", + "locationName": "expirationTime" + }, + "RequesterVpcInfo": { + "type": "structure", + "locationName": "requesterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + } + } + }, + "Status": { + "type": "structure", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "VpcPeeringConnectionId": { + "type": "string", + "locationName": "vpcPeeringConnectionId" + } + } + } + } + } + } + }, + "DescribeVpcs": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "VpcId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Vpcs": { + "type": "list", + "locationName": "vpcSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "CidrBlock": { + "type": "string", + "locationName": "cidrBlock" + }, + "DhcpOptionsId": { + "type": "string", + "locationName": "dhcpOptionsId" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "InstanceTenancy": { + "type": "string", + "locationName": "instanceTenancy" + }, + "IsDefault": { + "type": "boolean", + "locationName": "isDefault" + } + } + } + } + } + } + }, + "DescribeVpnConnections": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VpnConnectionIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "VpnConnectionId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnConnections": { + "type": "list", + "locationName": "vpnConnectionSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VpnConnectionId": { + "type": "string", + "locationName": "vpnConnectionId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "CustomerGatewayConfiguration": { + "type": "string", + "locationName": "customerGatewayConfiguration" + }, + "Type": { + "type": "string", + "locationName": "type" + }, + "CustomerGatewayId": { + "type": "string", + "locationName": "customerGatewayId" + }, + "VpnGatewayId": { + "type": "string", + "locationName": "vpnGatewayId" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "VgwTelemetry": { + "type": "list", + "locationName": "vgwTelemetry", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "OutsideIpAddress": { + "type": "string", + "locationName": "outsideIpAddress" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "LastStatusChange": { + "type": "timestamp", + "locationName": "lastStatusChange" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "AcceptedRouteCount": { + "type": "integer", + "locationName": "acceptedRouteCount" + } + } + } + }, + "Options": { + "type": "structure", + "locationName": "options", + "members": { + "StaticRoutesOnly": { + "type": "boolean", + "locationName": "staticRoutesOnly" + } + } + }, + "Routes": { + "type": "list", + "locationName": "routes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "DestinationCidrBlock": { + "type": "string", + "locationName": "destinationCidrBlock" + }, + "Source": { + "type": "string", + "locationName": "source" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + } + } + } + } + } + } + }, + "DescribeVpnGateways": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "VpnGatewayIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "VpnGatewayId" + } + }, + "Filters": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Filter", + "members": { + "Name": { + "type": "string" + }, + "Values": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "VpnGateways": { + "type": "list", + "locationName": "vpnGatewaySet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VpnGatewayId": { + "type": "string", + "locationName": "vpnGatewayId" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Type": { + "type": "string", + "locationName": "type" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "VpcAttachments": { + "type": "list", + "locationName": "attachments", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "locationName": "state" + } + } + } + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + } + }, + "DetachInternetGateway": { + "input": { + "type": "structure", + "required": [ + "InternetGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InternetGatewayId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": null + }, + "DetachNetworkInterface": { + "input": { + "type": "structure", + "required": [ + "AttachmentId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "AttachmentId": { + "type": "string" + }, + "Force": { + "type": "boolean" + } + } + }, + "output": null + }, + "DetachVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeId": { + "type": "string" + }, + "InstanceId": { + "type": "string" + }, + "Device": { + "type": "string" + }, + "Force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "locationName": "attachment", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Device": { + "type": "string", + "locationName": "device" + }, + "State": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + } + }, + "DetachVpnGateway": { + "input": { + "type": "structure", + "required": [ + "VpnGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpnGatewayId": { + "type": "string" + }, + "VpcId": { + "type": "string" + } + } + }, + "output": null + }, + "DisableVgwRoutePropagation": { + "input": { + "type": "structure", + "required": [ + "RouteTableId", + "GatewayId" + ], + "members": { + "RouteTableId": { + "type": "string" + }, + "GatewayId": { + "type": "string" + } + } + }, + "output": null + }, + "DisassociateAddress": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "PublicIp": { + "type": "string" + }, + "AssociationId": { + "type": "string" + } + } + }, + "output": null + }, + "DisassociateRouteTable": { + "input": { + "type": "structure", + "required": [ + "AssociationId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "AssociationId": { + "type": "string" + } + } + }, + "output": null + }, + "EnableVgwRoutePropagation": { + "input": { + "type": "structure", + "required": [ + "RouteTableId", + "GatewayId" + ], + "members": { + "RouteTableId": { + "type": "string" + }, + "GatewayId": { + "type": "string" + } + } + }, + "output": null + }, + "EnableVolumeIO": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeId": { + "type": "string" + } + } + }, + "output": null + }, + "GetConsoleOutput": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Timestamp": { + "type": "timestamp", + "locationName": "timestamp" + }, + "Output": { + "type": "string", + "locationName": "output" + } + } + } + }, + "GetPasswordData": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Timestamp": { + "type": "timestamp", + "locationName": "timestamp" + }, + "PasswordData": { + "type": "string", + "locationName": "passwordData" + } + } + } + }, + "ImportInstance": { + "input": { + "type": "structure", + "required": [ + "Platform" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Description": { + "type": "string" + }, + "LaunchSpecification": { + "type": "structure", + "members": { + "Architecture": { + "type": "string" + }, + "GroupNames": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "GroupName" + } + }, + "AdditionalInfo": { + "type": "string" + }, + "UserData": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "Placement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "Tenancy": { + "type": "string" + } + } + }, + "Monitoring": { + "type": "boolean" + }, + "SubnetId": { + "type": "string" + }, + "InstanceInitiatedShutdownBehavior": { + "type": "string" + }, + "PrivateIpAddress": { + "type": "string" + } + } + }, + "DiskImages": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "DiskImage", + "members": { + "Image": { + "type": "structure", + "required": [ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members": { + "Format": { + "type": "string" + }, + "Bytes": { + "type": "long" + }, + "ImportManifestUrl": { + "type": "string" + } + } + }, + "Description": { + "type": "string" + }, + "Volume": { + "type": "structure", + "required": [ + "Size" + ], + "members": { + "Size": { + "type": "long" + } + } + } + } + } + }, + "Platform": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "ConversionTask": { + "type": "structure", + "locationName": "conversionTask", + "required": [ + "ConversionTaskId", + "State" + ], + "members": { + "ConversionTaskId": { + "type": "string", + "locationName": "conversionTaskId" + }, + "ExpirationTime": { + "type": "string", + "locationName": "expirationTime" + }, + "ImportInstance": { + "type": "structure", + "locationName": "importInstance", + "required": [ + "Volumes" + ], + "members": { + "Volumes": { + "type": "list", + "locationName": "volumes", + "member": { + "type": "structure", + "locationName": "item", + "required": [ + "BytesConverted", + "AvailabilityZone", + "Status" + ], + "members": { + "BytesConverted": { + "type": "long", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Image": { + "type": "structure", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "locationName": "format" + }, + "Size": { + "type": "long", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "locationName": "size" + }, + "Id": { + "type": "string", + "locationName": "id" + } + } + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "Description": { + "type": "string", + "locationName": "description" + } + } + } + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Platform": { + "type": "string", + "locationName": "platform" + }, + "Description": { + "type": "string", + "locationName": "description" + } + } + }, + "ImportVolume": { + "type": "structure", + "locationName": "importVolume", + "required": [ + "BytesConverted", + "AvailabilityZone" + ], + "members": { + "BytesConverted": { + "type": "long", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "Image": { + "type": "structure", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "locationName": "format" + }, + "Size": { + "type": "long", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "locationName": "size" + }, + "Id": { + "type": "string", + "locationName": "id" + } + } + } + } + }, + "State": { + "type": "string", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "ImportKeyPair": { + "input": { + "type": "structure", + "required": [ + "KeyName", + "PublicKeyMaterial" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "KeyName": { + "type": "string" + }, + "PublicKeyMaterial": { + "type": "blob" + } + } + }, + "output": { + "type": "structure", + "members": { + "KeyName": { + "type": "string", + "locationName": "keyName" + }, + "KeyFingerprint": { + "type": "string", + "locationName": "keyFingerprint" + } + } + } + }, + "ImportVolume": { + "input": { + "type": "structure", + "required": [ + "AvailabilityZone" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "AvailabilityZone": { + "type": "string" + }, + "Image": { + "type": "structure", + "required": [ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members": { + "Format": { + "type": "string" + }, + "Bytes": { + "type": "long" + }, + "ImportManifestUrl": { + "type": "string" + } + } + }, + "Description": { + "type": "string" + }, + "Volume": { + "type": "structure", + "required": [ + "Size" + ], + "members": { + "Size": { + "type": "long" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ConversionTask": { + "type": "structure", + "locationName": "conversionTask", + "required": [ + "ConversionTaskId", + "State" + ], + "members": { + "ConversionTaskId": { + "type": "string", + "locationName": "conversionTaskId" + }, + "ExpirationTime": { + "type": "string", + "locationName": "expirationTime" + }, + "ImportInstance": { + "type": "structure", + "locationName": "importInstance", + "required": [ + "Volumes" + ], + "members": { + "Volumes": { + "type": "list", + "locationName": "volumes", + "member": { + "type": "structure", + "locationName": "item", + "required": [ + "BytesConverted", + "AvailabilityZone", + "Status" + ], + "members": { + "BytesConverted": { + "type": "long", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Image": { + "type": "structure", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "locationName": "format" + }, + "Size": { + "type": "long", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "locationName": "size" + }, + "Id": { + "type": "string", + "locationName": "id" + } + } + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "Description": { + "type": "string", + "locationName": "description" + } + } + } + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Platform": { + "type": "string", + "locationName": "platform" + }, + "Description": { + "type": "string", + "locationName": "description" + } + } + }, + "ImportVolume": { + "type": "structure", + "locationName": "importVolume", + "required": [ + "BytesConverted", + "AvailabilityZone" + ], + "members": { + "BytesConverted": { + "type": "long", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "Image": { + "type": "structure", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "locationName": "format" + }, + "Size": { + "type": "long", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "locationName": "size" + }, + "Id": { + "type": "string", + "locationName": "id" + } + } + } + } + }, + "State": { + "type": "string", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "locationName": "statusMessage" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "ModifyImageAttribute": { + "input": { + "type": "structure", + "required": [ + "ImageId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ImageId": { + "type": "string" + }, + "Attribute": { + "type": "string" + }, + "OperationType": { + "type": "string" + }, + "UserIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "UserId" + } + }, + "UserGroups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "UserGroup" + } + }, + "ProductCodes": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ProductCode" + } + }, + "Value": { + "type": "string" + }, + "LaunchPermission": { + "type": "structure", + "members": { + "Add": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "UserId": { + "type": "string" + }, + "Group": { + "type": "string" + } + } + } + }, + "Remove": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "UserId": { + "type": "string" + }, + "Group": { + "type": "string" + } + } + } + } + } + }, + "Description": { + "type": "structure", + "members": { + "Value": { + "type": "string" + } + } + } + } + }, + "output": null + }, + "ModifyInstanceAttribute": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": { + "type": "string" + }, + "Attribute": { + "type": "string" + }, + "Value": { + "type": "string" + }, + "BlockDeviceMappings": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "BlockDeviceMapping", + "members": { + "DeviceName": { + "type": "string" + }, + "Ebs": { + "type": "structure", + "members": { + "VolumeId": { + "type": "string" + }, + "DeleteOnTermination": { + "type": "boolean" + } + } + }, + "VirtualName": { + "type": "string" + }, + "NoDevice": { + "type": "string" + } + } + } + }, + "SourceDestCheck": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + } + } + }, + "DisableApiTermination": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + } + } + }, + "InstanceType": { + "type": "structure", + "members": { + "Value": { + "type": "string" + } + } + }, + "Kernel": { + "type": "structure", + "members": { + "Value": { + "type": "string" + } + } + }, + "Ramdisk": { + "type": "structure", + "members": { + "Value": { + "type": "string" + } + } + }, + "UserData": { + "type": "structure", + "members": { + "Value": { + "type": "blob" + } + } + }, + "InstanceInitiatedShutdownBehavior": { + "type": "structure", + "members": { + "Value": { + "type": "string" + } + } + }, + "Groups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "GroupId" + } + }, + "EbsOptimized": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + } + } + }, + "SriovNetSupport": { + "type": "structure", + "members": { + "Value": { + "type": "string" + } + } + } + } + }, + "output": null + }, + "ModifyNetworkInterfaceAttribute": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "Description": { + "type": "structure", + "members": { + "Value": { + "type": "string" + } + } + }, + "SourceDestCheck": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + } + } + }, + "Groups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "Attachment": { + "type": "structure", + "members": { + "AttachmentId": { + "type": "string" + }, + "DeleteOnTermination": { + "type": "boolean" + } + } + } + } + }, + "output": null + }, + "ModifyReservedInstances": { + "input": { + "type": "structure", + "required": [ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members": { + "ClientToken": { + "type": "string" + }, + "ReservedInstancesIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ReservedInstancesId" + } + }, + "TargetConfigurations": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "ReservedInstancesConfigurationSetItemType", + "members": { + "AvailabilityZone": { + "type": "string" + }, + "Platform": { + "type": "string" + }, + "InstanceCount": { + "type": "integer" + }, + "InstanceType": { + "type": "string" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesModificationId": { + "type": "string", + "locationName": "reservedInstancesModificationId" + } + } + } + }, + "ModifySnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "SnapshotId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SnapshotId": { + "type": "string" + }, + "Attribute": { + "type": "string" + }, + "OperationType": { + "type": "string" + }, + "UserIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "UserId" + } + }, + "GroupNames": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "UserGroup" + } + }, + "CreateVolumePermission": { + "type": "structure", + "members": { + "Add": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "UserId": { + "type": "string" + }, + "Group": { + "type": "string" + } + } + } + }, + "Remove": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "UserId": { + "type": "string" + }, + "Group": { + "type": "string" + } + } + } + } + } + } + } + }, + "output": null + }, + "ModifySubnetAttribute": { + "input": { + "type": "structure", + "required": [ + "SubnetId" + ], + "members": { + "SubnetId": { + "type": "string" + }, + "MapPublicIpOnLaunch": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + } + } + } + } + }, + "output": null + }, + "ModifyVolumeAttribute": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VolumeId": { + "type": "string" + }, + "AutoEnableIO": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + } + } + } + } + }, + "output": null + }, + "ModifyVpcAttribute": { + "input": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "VpcId": { + "type": "string" + }, + "EnableDnsSupport": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + } + } + }, + "EnableDnsHostnames": { + "type": "structure", + "members": { + "Value": { + "type": "boolean" + } + } + } + } + }, + "output": null + }, + "MonitorInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceMonitorings": { + "type": "list", + "locationName": "instancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Monitoring": { + "type": "structure", + "locationName": "monitoring", + "members": { + "State": { + "type": "string", + "locationName": "state" + } + } + } + } + } + } + } + } + }, + "PurchaseReservedInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ReservedInstancesOfferingId": { + "type": "string" + }, + "InstanceCount": { + "type": "integer" + }, + "LimitPrice": { + "type": "structure", + "members": { + "Amount": { + "type": "double" + }, + "CurrencyCode": { + "type": "string" + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "type": "string", + "locationName": "reservedInstancesId" + } + } + } + }, + "RebootInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + } + } + }, + "output": null + }, + "RegisterImage": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ImageLocation": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Architecture": { + "type": "string" + }, + "KernelId": { + "type": "string" + }, + "RamdiskId": { + "type": "string" + }, + "RootDeviceName": { + "type": "string" + }, + "BlockDeviceMappings": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "BlockDeviceMapping", + "members": { + "VirtualName": { + "type": "string" + }, + "DeviceName": { + "type": "string" + }, + "Ebs": { + "type": "structure", + "members": { + "SnapshotId": { + "type": "string" + }, + "VolumeSize": { + "type": "integer" + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "VolumeType": { + "type": "string" + }, + "Iops": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + } + } + }, + "NoDevice": { + "type": "string" + } + } + } + }, + "VirtualizationType": { + "type": "string" + }, + "SriovNetSupport": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "ImageId": { + "type": "string", + "locationName": "imageId" + } + } + } + }, + "RejectVpcPeeringConnection": { + "input": { + "type": "structure", + "required": [ + "VpcPeeringConnectionId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "VpcPeeringConnectionId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "Return": { + "type": "boolean", + "locationName": "return" + } + } + } + }, + "ReleaseAddress": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "PublicIp": { + "type": "string" + }, + "AllocationId": { + "type": "string" + } + } + }, + "output": null + }, + "ReplaceNetworkAclAssociation": { + "input": { + "type": "structure", + "required": [ + "AssociationId", + "NetworkAclId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "AssociationId": { + "type": "string" + }, + "NetworkAclId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "NewAssociationId": { + "type": "string", + "locationName": "newAssociationId" + } + } + } + }, + "ReplaceNetworkAclEntry": { + "input": { + "type": "structure", + "required": [ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkAclId": { + "type": "string" + }, + "RuleNumber": { + "type": "integer" + }, + "Protocol": { + "type": "string" + }, + "RuleAction": { + "type": "string" + }, + "Egress": { + "type": "boolean" + }, + "CidrBlock": { + "type": "string" + }, + "IcmpTypeCode": { + "type": "structure", + "locationName": "Icmp", + "members": { + "Type": { + "type": "integer" + }, + "Code": { + "type": "integer" + } + } + }, + "PortRange": { + "type": "structure", + "members": { + "From": { + "type": "integer" + }, + "To": { + "type": "integer" + } + } + } + } + }, + "output": null + }, + "ReplaceRoute": { + "input": { + "type": "structure", + "required": [ + "RouteTableId", + "DestinationCidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "RouteTableId": { + "type": "string" + }, + "DestinationCidrBlock": { + "type": "string" + }, + "GatewayId": { + "type": "string" + }, + "InstanceId": { + "type": "string" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "VpcPeeringConnectionId": { + "type": "string" + } + } + }, + "output": null + }, + "ReplaceRouteTableAssociation": { + "input": { + "type": "structure", + "required": [ + "AssociationId", + "RouteTableId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "AssociationId": { + "type": "string" + }, + "RouteTableId": { + "type": "string" + } + } + }, + "output": { + "type": "structure", + "members": { + "NewAssociationId": { + "type": "string", + "locationName": "newAssociationId" + } + } + } + }, + "ReportInstanceStatus": { + "input": { + "type": "structure", + "required": [ + "Instances", + "Status", + "ReasonCodes" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "Instances": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + }, + "Status": { + "type": "string" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "ReasonCodes": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "ReasonCode" + } + }, + "Description": { + "type": "string" + } + } + }, + "output": null + }, + "RequestSpotInstances": { + "input": { + "type": "structure", + "required": [ + "SpotPrice" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SpotPrice": { + "type": "string" + }, + "InstanceCount": { + "type": "integer" + }, + "Type": { + "type": "string" + }, + "ValidFrom": { + "type": "timestamp" + }, + "ValidUntil": { + "type": "timestamp" + }, + "LaunchGroup": { + "type": "string" + }, + "AvailabilityZoneGroup": { + "type": "string" + }, + "LaunchSpecification": { + "type": "structure", + "members": { + "ImageId": { + "type": "string" + }, + "KeyName": { + "type": "string" + }, + "UserData": { + "type": "string" + }, + "AddressingType": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "Placement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "type": "string" + }, + "GroupName": { + "type": "string" + } + } + }, + "KernelId": { + "type": "string" + }, + "RamdiskId": { + "type": "string" + }, + "BlockDeviceMappings": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "BlockDeviceMapping", + "members": { + "VirtualName": { + "type": "string" + }, + "DeviceName": { + "type": "string" + }, + "Ebs": { + "type": "structure", + "members": { + "SnapshotId": { + "type": "string" + }, + "VolumeSize": { + "type": "integer" + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "VolumeType": { + "type": "string" + }, + "Iops": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + } + } + }, + "NoDevice": { + "type": "string" + } + } + } + }, + "Monitoring": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "SubnetId": { + "type": "string" + }, + "NetworkInterfaces": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "NetworkInterface", + "members": { + "NetworkInterfaceId": { + "type": "string" + }, + "DeviceIndex": { + "type": "integer" + }, + "SubnetId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "PrivateIpAddress": { + "type": "string" + }, + "Groups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "PrivateIpAddresses": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string" + }, + "Primary": { + "type": "boolean" + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer" + }, + "AssociatePublicIpAddress": { + "type": "boolean" + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "type": "string" + }, + "Name": { + "type": "string" + } + } + }, + "EbsOptimized": { + "type": "boolean" + }, + "SecurityGroupIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "SecurityGroups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroup" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "SpotInstanceRequests": { + "type": "list", + "locationName": "spotInstanceRequestSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "SpotInstanceRequestId": { + "type": "string", + "locationName": "spotInstanceRequestId" + }, + "SpotPrice": { + "type": "string", + "locationName": "spotPrice" + }, + "Type": { + "type": "string", + "locationName": "type" + }, + "State": { + "type": "string", + "locationName": "state" + }, + "Fault": { + "type": "structure", + "locationName": "fault", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "Status": { + "type": "structure", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "UpdateTime": { + "type": "timestamp", + "locationName": "updateTime" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "ValidFrom": { + "type": "timestamp", + "locationName": "validFrom" + }, + "ValidUntil": { + "type": "timestamp", + "locationName": "validUntil" + }, + "LaunchGroup": { + "type": "string", + "locationName": "launchGroup" + }, + "AvailabilityZoneGroup": { + "type": "string", + "locationName": "availabilityZoneGroup" + }, + "LaunchSpecification": { + "type": "structure", + "locationName": "launchSpecification", + "members": { + "ImageId": { + "type": "string", + "locationName": "imageId" + }, + "KeyName": { + "type": "string", + "locationName": "keyName" + }, + "SecurityGroups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "UserData": { + "type": "string", + "locationName": "userData" + }, + "AddressingType": { + "type": "string", + "locationName": "addressingType" + }, + "InstanceType": { + "type": "string", + "locationName": "instanceType" + }, + "Placement": { + "type": "structure", + "locationName": "placement", + "members": { + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "GroupName": { + "type": "string", + "locationName": "groupName" + } + } + }, + "KernelId": { + "type": "string", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "locationName": "ramdiskId" + }, + "BlockDeviceMappings": { + "type": "list", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "VirtualName": { + "type": "string", + "locationName": "virtualName" + }, + "DeviceName": { + "type": "string", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "locationName": "ebs", + "members": { + "SnapshotId": { + "type": "string", + "locationName": "snapshotId" + }, + "VolumeSize": { + "type": "integer", + "locationName": "volumeSize" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + }, + "VolumeType": { + "type": "string", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "locationName": "encrypted" + } + } + }, + "NoDevice": { + "type": "string", + "locationName": "noDevice" + } + } + } + }, + "MonitoringEnabled": { + "type": "boolean", + "locationName": "monitoringEnabled" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "NetworkInterfaces": { + "type": "list", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "DeviceIndex": { + "type": "integer", + "locationName": "deviceIndex" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "Groups": { + "type": "list", + "locationName": "SecurityGroupId", + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + }, + "PrivateIpAddresses": { + "type": "list", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "locationName": "item", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "Primary": { + "type": "boolean", + "locationName": "primary" + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer", + "locationName": "secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress": { + "type": "boolean", + "locationName": "associatePublicIpAddress" + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "locationName": "iamInstanceProfile", + "members": { + "Arn": { + "type": "string", + "locationName": "arn" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + }, + "EbsOptimized": { + "type": "boolean", + "locationName": "ebsOptimized" + } + } + }, + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "CreateTime": { + "type": "timestamp", + "locationName": "createTime" + }, + "ProductDescription": { + "type": "string", + "locationName": "productDescription" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "LaunchedAvailabilityZone": { + "type": "string", + "locationName": "launchedAvailabilityZone" + } + } + } + } + } + } + }, + "ResetImageAttribute": { + "input": { + "type": "structure", + "required": [ + "ImageId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ImageId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": null + }, + "ResetInstanceAttribute": { + "input": { + "type": "structure", + "required": [ + "InstanceId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": null + }, + "ResetNetworkInterfaceAttribute": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "NetworkInterfaceId": { + "type": "string" + }, + "SourceDestCheck": { + "type": "string" + } + } + }, + "output": null + }, + "ResetSnapshotAttribute": { + "input": { + "type": "structure", + "required": [ + "SnapshotId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "SnapshotId": { + "type": "string" + }, + "Attribute": { + "type": "string" + } + } + }, + "output": null + }, + "RevokeSecurityGroupEgress": { + "input": { + "type": "structure", + "required": [ + "GroupId" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupId": { + "type": "string" + }, + "SourceSecurityGroupName": { + "type": "string" + }, + "SourceSecurityGroupOwnerId": { + "type": "string" + }, + "IpProtocol": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "CidrIp": { + "type": "string" + }, + "IpPermissions": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "IpProtocol": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "UserIdGroupPairs": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Groups", + "members": { + "UserId": { + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "GroupId": { + "type": "string" + } + } + } + }, + "IpRanges": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "CidrIp": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "output": null + }, + "RevokeSecurityGroupIngress": { + "input": { + "type": "structure", + "members": { + "DryRun": { + "type": "boolean" + }, + "GroupName": { + "type": "string" + }, + "GroupId": { + "type": "string" + }, + "SourceSecurityGroupName": { + "type": "string" + }, + "SourceSecurityGroupOwnerId": { + "type": "string" + }, + "IpProtocol": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "CidrIp": { + "type": "string" + }, + "IpPermissions": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "IpProtocol": { + "type": "string" + }, + "FromPort": { + "type": "integer" + }, + "ToPort": { + "type": "integer" + }, + "UserIdGroupPairs": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "Groups", + "members": { + "UserId": { + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "GroupId": { + "type": "string" + } + } + } + }, + "IpRanges": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "members": { + "CidrIp": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "output": null + }, + "RunInstances": { + "input": { + "type": "structure", + "required": [ + "ImageId", + "MinCount", + "MaxCount" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "ImageId": { + "type": "string" + }, + "MinCount": { + "type": "integer" + }, + "MaxCount": { + "type": "integer" + }, + "KeyName": { + "type": "string" + }, + "SecurityGroups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroup" + } + }, + "SecurityGroupIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "UserData": { + "type": "string" + }, + "InstanceType": { + "type": "string" + }, + "Placement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "type": "string" + }, + "GroupName": { + "type": "string" + }, + "Tenancy": { + "type": "string" + } + } + }, + "KernelId": { + "type": "string" + }, + "RamdiskId": { + "type": "string" + }, + "BlockDeviceMappings": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "BlockDeviceMapping", + "members": { + "VirtualName": { + "type": "string" + }, + "DeviceName": { + "type": "string" + }, + "Ebs": { + "type": "structure", + "members": { + "SnapshotId": { + "type": "string" + }, + "VolumeSize": { + "type": "integer" + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "VolumeType": { + "type": "string" + }, + "Iops": { + "type": "integer" + }, + "Encrypted": { + "type": "boolean" + } + } + }, + "NoDevice": { + "type": "string" + } + } + } + }, + "Monitoring": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "SubnetId": { + "type": "string" + }, + "DisableApiTermination": { + "type": "boolean" + }, + "InstanceInitiatedShutdownBehavior": { + "type": "string" + }, + "PrivateIpAddress": { + "type": "string" + }, + "ClientToken": { + "type": "string" + }, + "AdditionalInfo": { + "type": "string" + }, + "NetworkInterfaces": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "locationName": "NetworkInterface", + "members": { + "NetworkInterfaceId": { + "type": "string" + }, + "DeviceIndex": { + "type": "integer" + }, + "SubnetId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "PrivateIpAddress": { + "type": "string" + }, + "Groups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "DeleteOnTermination": { + "type": "boolean" + }, + "PrivateIpAddresses": { + "type": "list", + "flattened": true, + "member": { + "type": "structure", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string" + }, + "Primary": { + "type": "boolean" + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer" + }, + "AssociatePublicIpAddress": { + "type": "boolean" + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "type": "string" + }, + "Name": { + "type": "string" + } + } + }, + "EbsOptimized": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "locationName": "reservation", + "members": { + "ReservationId": { + "type": "string", + "locationName": "reservationId" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "RequesterId": { + "type": "string", + "locationName": "requesterId" + }, + "Groups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "Instances": { + "type": "list", + "locationName": "instancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "ImageId": { + "type": "string", + "locationName": "imageId" + }, + "State": { + "type": "structure", + "locationName": "instanceState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "PublicDnsName": { + "type": "string", + "locationName": "dnsName" + }, + "StateTransitionReason": { + "type": "string", + "locationName": "reason" + }, + "KeyName": { + "type": "string", + "locationName": "keyName" + }, + "AmiLaunchIndex": { + "type": "integer", + "locationName": "amiLaunchIndex" + }, + "ProductCodes": { + "type": "list", + "locationName": "productCodes", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "locationName": "type" + } + } + } + }, + "InstanceType": { + "type": "string", + "locationName": "instanceType" + }, + "LaunchTime": { + "type": "timestamp", + "locationName": "launchTime" + }, + "Placement": { + "type": "structure", + "locationName": "placement", + "members": { + "AvailabilityZone": { + "type": "string", + "locationName": "availabilityZone" + }, + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "Tenancy": { + "type": "string", + "locationName": "tenancy" + } + } + }, + "KernelId": { + "type": "string", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "locationName": "ramdiskId" + }, + "Platform": { + "type": "string", + "locationName": "platform" + }, + "Monitoring": { + "type": "structure", + "locationName": "monitoring", + "members": { + "State": { + "type": "string", + "locationName": "state" + } + } + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PublicIpAddress": { + "type": "string", + "locationName": "ipAddress" + }, + "StateReason": { + "type": "structure", + "locationName": "stateReason", + "members": { + "Code": { + "type": "string", + "locationName": "code" + }, + "Message": { + "type": "string", + "locationName": "message" + } + } + }, + "Architecture": { + "type": "string", + "locationName": "architecture" + }, + "RootDeviceType": { + "type": "string", + "locationName": "rootDeviceType" + }, + "RootDeviceName": { + "type": "string", + "locationName": "rootDeviceName" + }, + "BlockDeviceMappings": { + "type": "list", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "DeviceName": { + "type": "string", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "locationName": "ebs", + "members": { + "VolumeId": { + "type": "string", + "locationName": "volumeId" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + } + } + } + }, + "VirtualizationType": { + "type": "string", + "locationName": "virtualizationType" + }, + "InstanceLifecycle": { + "type": "string", + "locationName": "instanceLifecycle" + }, + "SpotInstanceRequestId": { + "type": "string", + "locationName": "spotInstanceRequestId" + }, + "ClientToken": { + "type": "string", + "locationName": "clientToken" + }, + "Tags": { + "type": "list", + "locationName": "tagSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "locationName": "key" + }, + "Value": { + "type": "string", + "locationName": "value" + } + } + } + }, + "SecurityGroups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "SourceDestCheck": { + "type": "boolean", + "locationName": "sourceDestCheck" + }, + "Hypervisor": { + "type": "string", + "locationName": "hypervisor" + }, + "NetworkInterfaces": { + "type": "list", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "locationName": "networkInterfaceId" + }, + "SubnetId": { + "type": "string", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "locationName": "vpcId" + }, + "Description": { + "type": "string", + "locationName": "description" + }, + "OwnerId": { + "type": "string", + "locationName": "ownerId" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "SourceDestCheck": { + "type": "boolean", + "locationName": "sourceDestCheck" + }, + "Groups": { + "type": "list", + "locationName": "groupSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "locationName": "attachmentId" + }, + "DeviceIndex": { + "type": "integer", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "locationName": "deleteOnTermination" + } + } + }, + "Association": { + "type": "structure", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "locationName": "ipOwnerId" + } + } + }, + "PrivateIpAddresses": { + "type": "list", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "PrivateIpAddress": { + "type": "string", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "locationName": "privateDnsName" + }, + "Primary": { + "type": "boolean", + "locationName": "primary" + }, + "Association": { + "type": "structure", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "locationName": "ipOwnerId" + } + } + } + } + } + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "locationName": "iamInstanceProfile", + "members": { + "Arn": { + "type": "string", + "locationName": "arn" + }, + "Id": { + "type": "string", + "locationName": "id" + } + } + }, + "EbsOptimized": { + "type": "boolean", + "locationName": "ebsOptimized" + }, + "SriovNetSupport": { + "type": "string", + "locationName": "sriovNetSupport" + } + } + } + } + } + } + }, + "StartInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + }, + "AdditionalInfo": { + "type": "string" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "StartingInstances": { + "type": "list", + "locationName": "instancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "CurrentState": { + "type": "structure", + "locationName": "currentState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + }, + "PreviousState": { + "type": "structure", + "locationName": "previousState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + } + } + } + } + } + } + }, + "StopInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + }, + "Force": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "StoppingInstances": { + "type": "list", + "locationName": "instancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "CurrentState": { + "type": "structure", + "locationName": "currentState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + }, + "PreviousState": { + "type": "structure", + "locationName": "previousState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + } + } + } + } + } + } + }, + "TerminateInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "TerminatingInstances": { + "type": "list", + "locationName": "instancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "CurrentState": { + "type": "structure", + "locationName": "currentState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + }, + "PreviousState": { + "type": "structure", + "locationName": "previousState", + "members": { + "Code": { + "type": "integer", + "locationName": "code" + }, + "Name": { + "type": "string", + "locationName": "name" + } + } + } + } + } + } + } + } + }, + "UnassignPrivateIpAddresses": { + "input": { + "type": "structure", + "required": [ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members": { + "NetworkInterfaceId": { + "type": "string" + }, + "PrivateIpAddresses": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "PrivateIpAddress" + } + } + } + }, + "output": null + }, + "UnmonitorInstances": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean" + }, + "InstanceIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "InstanceId" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceMonitorings": { + "type": "list", + "locationName": "instancesSet", + "member": { + "type": "structure", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "locationName": "instanceId" + }, + "Monitoring": { + "type": "structure", + "locationName": "monitoring", + "members": { + "State": { + "type": "string", + "locationName": "state" + } + } + } + } + } + } + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/apis/ec2-2014-06-15.full.json b/apis/ec2-2014-06-15.full.json new file mode 100644 index 0000000000..d602f8b272 --- /dev/null +++ b/apis/ec2-2014-06-15.full.json @@ -0,0 +1,18153 @@ +{ + "documentation": "\n\t\tAmazon Elastic Compute Cloud\n

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing\n capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates\n your need to invest in hardware up front, so you can develop and deploy\n applications faster.

\n ", + "metadata": { + "apiVersion": "2014-06-15", + "protocol": "query", + "resultWrapped": false, + "signatureVersion": "v2", + "serviceFullName": "Amazon Elastic Compute Cloud", + "serviceAbbreviation": "Amazon EC2", + "endpointPrefix": "ec2", + "xmlNamespace": "http://ec2.amazonaws.com/doc/2014-06-15" + }, + "operations": { + "AcceptVpcPeeringConnection": { + "name": "AcceptVpcPeeringConnection", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of the VPC peering connection.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpcPeeringConnection": { + "type": "structure", + "documentation": "\n

Information about the VPC peering connection.

\n ", + "locationName": "vpcPeeringConnection", + "members": { + "AccepterVpcInfo": { + "type": "structure", + "documentation": "\n

The information of the peer VPC.

\n ", + "locationName": "accepterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "documentation": "\n

The CIDR block for the VPC.

\n ", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the VPC owner.

\n ", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC.

\n ", + "locationName": "vpcId" + } + } + }, + "ExpirationTime": { + "type": "timestamp", + "documentation": "\n

The time that an unaccepted VPC peering connection will expire.

\n ", + "locationName": "expirationTime" + }, + "RequesterVpcInfo": { + "type": "structure", + "documentation": "\n

The information of the requester VPC.

\n ", + "locationName": "requesterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "documentation": "\n

The CIDR block for the VPC.

\n ", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the VPC owner.

\n ", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC.

\n ", + "locationName": "vpcId" + } + } + }, + "Status": { + "type": "structure", + "documentation": "\n

The status of the VPC peering connection.

\n ", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The status of the VPC peering connection.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

A message that provides more information about the status, if applicable.

\n ", + "locationName": "message" + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of the VPC peering connection.

\n ", + "locationName": "vpcPeeringConnectionId" + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Accept a VPC peering connection request. To accept a request, the VPC peering connection\n must be in the pending-acceptance state, and you must be the owner of\n the peer VPC. Use the DescribeVpcPeeringConnections request to\n view your outstanding VPC peering connection requests.

\n \n \n Example\n This example accepts the specified VPC peering connection\n request.\n https://ec2.amazonaws.com/?Action=AcceptVpcPeeringConnection\n&vpcPeeringConnectionId=pcx-1a2b3c4d\n&AUTHPARAMS\n <AcceptVpcPeeringConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpcPeeringConnection>\n <vpcPeeringConnectionId>pcx-1a2b3c4d</vpcPeeringConnectionId>\n <requesterVpcInfo>\n <ownerId>123456789012</ownerId>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <cidrBlock>10.0.0.0/28</cidrBlock>\n </requesterVpcInfo>\n <accepterVpcInfo>\n <ownerId>777788889999</ownerId>\n <vpcId>vpc-111aaa22</vpcId>\n <cidrBlock>10.0.1.0/28</cidrBlock>\n </accepterVpcInfo>\n <status>\n <code>active</code>\n <message>Active</message>\n </status>\n <tagSet/>\n </vpcPeeringConnection>\n </AcceptVpcPeeringConnectionResponse>\"\n \n \n " + }, + "AllocateAddress": { + "name": "AllocateAddress", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Domain": { + "type": "string", + "enum": [ + "vpc", + "standard" + ], + "documentation": "\n

Set to vpc to allocate the address for use with instances in a VPC.

\n

Default: The address is for use with instances in EC2-Classic.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n

The Elastic IP address.

\n ", + "locationName": "publicIp" + }, + "Domain": { + "type": "string", + "enum": [ + "vpc", + "standard" + ], + "documentation": "\n

Indicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).

\n ", + "locationName": "domain" + }, + "AllocationId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The ID that AWS assigns to represent the allocation of\n\t\t\t\tthe Elastic IP address for use with instances in a VPC.

\n ", + "locationName": "allocationId" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Acquires an Elastic IP address.

\n

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example for EC2-Classic\n This example request allocates an Elastic IP address for use with instances in EC2-Classic.\n https://ec2.amazonaws.com/?Action=AllocateAddress\n&AUTHPARAMS\n <AllocateAddressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <publicIp>192.0.2.1</publicIp>\n <domain>standard</domain>\n</AllocateAddressResponse>\n \n \n Example for EC2-VPC\n This example request allocates an Elastic IP address for use with instances in a VPC.\n https://ec2.amazonaws.com/?Action=AllocateAddress\nDomain=vpc\n&AUTHPARAMS\n <AllocateAddressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <publicIp>198.51.100.1</publicIp>\n <domain>vpc</domain>\n <allocationId>eipalloc-5723d13e</allocationId>\n</AllocateAddressResponse>\n \n \n " + }, + "AssignPrivateIpAddresses": { + "name": "AssignPrivateIpAddresses", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n

The ID of the network interface.

\n " + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n

One or more IP addresses to be assigned as a secondary private IP address to\n\t\t\t\tthe network interface.

\n\t\t

If you don't specify an IP address, Amazon EC2 automatically\n\t\t\t\tselects an IP address within the subnet range.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "PrivateIpAddress" + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer", + "documentation": "\n

The number of secondary IP addresses to assign to the network interface.

\n " + }, + "AllowReassignment": { + "type": "boolean", + "documentation": "\n

Indicates whether to allow an IP address that is already assigned\n\t\t\t\tto another network interface or instance to be reassigned to the\n\t\t\t\tspecified network interface.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Assigns one or more secondary private IP addresses to the specified network interface. You\n\t\t\t\tcan specify one or more specific secondary IP addresses, or\n\t\t\t\tyou can specify the number of secondary IP addresses to be automatically assigned\n\t\t\t\twithin the subnet's CIDR block range. The number of secondary IP addresses that you\n\t\t\t\tcan assign to an instance varies by instance type. For information about\n\t\t\t\tinstance types, see Instance Types \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP\n\t\t\t\taddresses, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.

\n

AssignPrivateIpAddresses is available only in EC2-VPC.

\n \n \n Example 1\n This example assigns two secondary private IP addresses (10.0.2.1 and\n\t\t\t\t\t10.0.2.11) to the specified network interface.\n https://ec2.amazonaws.com/?Action=AssignPrivateIpAddresses\n&NetworkInterfaceId=eni-d83388b1\n&PrivateIpAddress.0=10.0.2.1\n&PrivateIpAddress.1=10.0.2.11\n&AUTHPARAMS\n <AssignPrivateIpAddresses xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</AssignPrivateIpAddresses>\n \n \n Example 2\n This example assigns two secondary private IP addresses to the specified network\n\t\t\t\t\tinterface. Amazon EC2 automatically assigns these IP addresses from the available IP\n\t\t\t\t\taddresses within the subnet's CIDR block range.\n https://ec2.amazonaws.com/?Action=AssignPrivateIpAddresses\n&NetworkInterfaceId=eni-d83388b1\n&SecondaryPrivateIpAddressCount=2\n&AUTHPARAMS\n <AssignPrivateIpAddresses xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</AssignPrivateIpAddresses>\n \n \n " + }, + "AssociateAddress": { + "name": "AssociateAddress", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance. The operation fails if\n\t\t\t\tyou specify an instance ID unless exactly one network interface is\n\t\t\t\tattached.

\n " + }, + "PublicIp": { + "type": "string", + "documentation": "\n

The Elastic IP address.

\n " + }, + "AllocationId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

\n " + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The ID of the network interface. If the instance has more than one \n network interface, you must specify a network interface ID.

\n " + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n

[EC2-VPC] The primary or secondary private IP address to associate\n\t\t\t\twith the Elastic IP address. If no private IP address is specified, the\n\t\t\t\tElastic IP address is associated with the primary private IP\n\t\t\t\taddress.

\n " + }, + "AllowReassociation": { + "type": "boolean", + "documentation": "\n

[EC2-VPC] Allows an Elastic IP address that is already associated\n\t\t\t\twith an instance or network interface to be re-associated with the\n\t\t\t\tspecified instance or network interface. Otherwise, the operation\n\t\t\t\tfails.

\n

Default: false

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "AssociationId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The ID that represents the association of the Elastic IP\n\t\t\t\taddress with an instance.

\n ", + "locationName": "associationId" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Associates an Elastic IP address with an instance or a network interface.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-Classic, default VPC] If the Elastic IP address is already associated with a different\n\t\t\t\tinstance, it is disassociated from that instance and associated with the specified\n\t\t\t\tinstance.

\n

[EC2-VPC] If you don't specify a private IP address, the Elastic IP address is\n\t\t\t\tassociated with the primary IP address. If the Elastic IP address is already\n\t\t\t\tassociated with a different instance or a network interface, you get an error unless\n\t\t\t\tyou allow reassociation.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n\t\t\t\tdoesn't return an error.

\n \n \n Example for EC2-Classic\n This example request associates an Elastic IP address with an instance in\n\t\t\t\t\tEC2-Classic.\n https://ec2.amazonaws.com/?Action=AssociateAddress\n&InstanceId=i-2ea64347\n&PublicIp=192.0.2.1\n&AUTHPARAMS\n <AssociateAddressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</AssociateAddressResponse>\n \n \n Example for EC2-VPC\n This example request associates a Elastic IP address with an instance in a VPC.\n\t\t\t\t\tThe AllowReassignment parameter allows the Elastic IP address to be associated with \n\t\t\t\t\tthe specified instance even if it's already associated with a different instance or a network interface.\n https://ec2.amazonaws.com/?Action=AssociateAddress\n&InstanceId=i-4fd2431a\n&AllocationId=eipalloc-5723d13e\n&AllowReassignment=true\n&AUTHPARAMS\n <AssociateAddressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n <associationId>eipassoc-fc5ca095</associationId>\n</AssociateAddressResponse>\n \n \n " + }, + "AssociateDhcpOptions": { + "name": "AssociateDhcpOptions", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "DhcpOptionsId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "DhcpOptionsId": { + "type": "string", + "documentation": "\n

The ID of the DHCP options set, or default to associate \n no DHCP options with the VPC.

\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Associates a set of DHCP options (that you've previously created) with the\n\t\t\t specified VPC, or associates no DHCP options with the VPC.

\n\t\t

After you associate the options with the VPC, any existing instances and all new\n \t\t\t instances that you launch in that VPC use the options. You don't need to restart or\n\t \t\t relaunch the instances. They automatically pick up the changes within a few hours,\n\t\t \t depending on how frequently the instance renews its DHCP lease. You can\n\t\t\t explicitly renew the lease using the operating system on the instance.

\n\t\t

For more information,\n\t\t\t see DHCP Options Sets \n\t\t\t in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example associates the DHCP options with the ID dopt-7a8b9c2d with the VPC\n\t\t\t\t\twith the ID vpc-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=AssociateDhcpOptions \n&DhcpOptionsId=dopt-7a8b9c2d\n&VpcId=vpc-1a2b3c4d\n&AUTHPARAMS\n <AssociateDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return> \n</AssociateDhcpOptionsResponse>\n \n \n Example 2\n This example changes the VPC with the ID vpc-1a2b3c4d to have no \n\t\t\t\t\tassociated DHCP options set.\n https://ec2.amazonaws.com/?Action=AssociateDhcpOptions \n&DhcpOptionsId=default\n&VpcId=vpc-1a2b3c4d\n&AUTHPARAMS\n <AssociateDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return> \n</AssociateDhcpOptionsResponse>\n \n \n " + }, + "AssociateRouteTable": { + "name": "AssociateRouteTable", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SubnetId", + "RouteTableId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n " + }, + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "AssociationId": { + "type": "string", + "documentation": "\n\t\t

The route table association ID (needed to disassociate the route table).

\n ", + "locationName": "associationId" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Associates a subnet with a route table. The subnet and route table must be in the same VPC.\n\t\t\t\tThis association causes traffic originating from the subnet to be routed according\n\t\t\t\tto the routes in the route table. The action returns an association ID, which you\n\t\t\t\tneed in order to disassociate the route table from the subnet later. A route table\n\t\t\t\tcan be associated with multiple subnets.

\n\t\t

For more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example associates a route table with the ID rtb-e4ad488d with a subnet with\n\t\t\t\t\tthe ID subnet-15ad487c.\n https://ec2.amazonaws.com/?Action=AssociateRouteTable\n&RouteTableId=rtb-e4ad488d\n&SubnetId=subnet-15ad487c\n <AssociateRouteTableResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <associationId>rtbassoc-f8ad4891</associationId>\n</AssociateRouteTableResponse>\n \n \n " + }, + "AttachInternetGateway": { + "name": "AttachInternetGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InternetGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InternetGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Internet gateway.

\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet\n\t\t\t\tand the VPC. For more information about your VPC and Internet gateway, see the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example attaches the Internet gateway with the ID igw-eaad4883 to the VPC with\n\t\t\t\t\tthe ID vpc-11ad4878.\n https://ec2.amazonaws.com/?Action=AttachInternetGateway\n&InternetGatewayId=igw-eaad4883\n&VpcId=vpc-11ad4878\n&AUTHPARAMS\n <AttachInternetGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</AttachInternetGatewayResponse>\n \n \n " + }, + "AttachNetworkInterface": { + "name": "AttachNetworkInterface", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the instance.

\n " + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The index of the device for the network interface attachment.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "AttachmentId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface attachment.

\n ", + "locationName": "attachmentId" + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Attaches a network interface to an instance.

\n \n \n Example\n This example attaches the specified network interface \n\t\t\t\t\tto the specified instance.\n https://ec2.amazonaws.com/?Action=AttachNetworkInterface\n&DeviceIndex=1\n&InstanceId=i-9cc316fe\n&NetworkInterfaceId=eni-ffda3197\n&AUTHPARAMS\n <AttachNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>ace8cd1e-e685-4e44-90fb-92014d907212</requestId>\n <attachmentId>eni-attach-d94b09b0</attachmentId>\n</AttachNetworkInterfaceResponse>\n \n \n " + }, + "AttachVolume": { + "name": "AttachVolume", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VolumeId", + "InstanceId", + "Device" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability\n Zone.

\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + }, + "Device": { + "type": "string", + "documentation": "\n

The device name to expose to the instance (for example, /dev/sdh or\n xvdh).

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "locationName": "attachment", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "Device": { + "type": "string", + "documentation": "\n

The device name.

\n ", + "locationName": "device" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n

The attachment state of the volume.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.

\n

Encrypted Amazon EBS volumes may only be attached to\n instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

\n

For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved\n for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the\n Amazon Elastic Compute Cloud User Guide.

\n

If a volume has an AWS Marketplace product code:

\n \n

For an overview of the AWS Marketplace, see https://aws.amazon.com/marketplace/help/200900000. For more information about how to use the AWS\n Marketplace, see AWS Marketplace.

\n

For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the\n Amazon Elastic Compute Cloud User Guide.

\n \n \n Example 1\n This example request attaches the volume with the ID vol-1a2b3c4d to\n the instance with the ID i-1a2b3c4d and exposes it as\n /dev/sdh.\n https://ec2.amazonaws.com/?Action=AttachVolume\n&VolumeId=vol-1a2b3c4d\n&InstanceId=i-1a2b3c4d\n&Device=/dev/sdh\n&AUTHPARAMS\n <AttachVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <volumeId>vol-1a2b3c4d</volumeId>\n <instanceId>i-1a2b3c4d</instanceId>\n <device>/dev/sdh</device>\n <status>attaching</status>\n <attachTime>YYYY-MM-DDTHH:MM:SS.000Z</attachTime>\n</AttachVolumeResponse>\n \n \n \n " + }, + "AttachVpnGateway": { + "name": "AttachVpnGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpnGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpnGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway.

\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpcAttachment": { + "type": "structure", + "documentation": "\n\t\t

Information about the attachment.

\n ", + "locationName": "attachment", + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The current state of the attachment.

\n ", + "locationName": "state" + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway\n\t\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example attaches the virtual private gateway with the ID vgw-8db04f81 to the VPC with the ID\n\t\t\t\t\tvpc-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=AttachVpnGateway\n&VpnGatewayId=vgw-8db04f81\n&VpcId=vpc-1a2b3c4d\n&AUTHPARAMS\n <AttachVpnGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <attachment>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <state>attaching</state>\n </attachment>\n</AttachVpnGatewayResponse>\n \n \n " + }, + "AuthorizeSecurityGroupEgress": { + "name": "AuthorizeSecurityGroupEgress", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "GroupId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n " + }, + "SourceSecurityGroupName": { + "type": "string", + "documentation": "\n

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

\n " + }, + "SourceSecurityGroupOwnerId": { + "type": "string", + "documentation": "\n

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

\n " + }, + "IpProtocol": { + "type": "string", + "documentation": "\n

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

\n " + }, + "FromPort": { + "type": "integer", + "documentation": "\n

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.

\n " + }, + "ToPort": { + "type": "integer", + "documentation": "\n

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.

\n " + }, + "CidrIp": { + "type": "string", + "documentation": "\n

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

\n " + }, + "IpPermissions": { + "type": "list", + "documentation": "\n

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a security group rule.

\n ", + "members": { + "IpProtocol": { + "type": "string", + "documentation": "\n\t\t

The protocol.

\n\t\t

When you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.

\n " + }, + "FromPort": { + "type": "integer", + "documentation": "\n\t\t

The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.

\n " + }, + "ToPort": { + "type": "integer", + "documentation": "\n\t\t

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.

\n " + }, + "UserIdGroupPairs": { + "type": "list", + "documentation": "\n\t\t

One or more security group and AWS account ID pairs.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a security group and AWS account ID pair for EC2-Classic.

\n ", + "locationName": "Groups", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The ID of an AWS account.

\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The ID of the security group owned by the specified AWS account.

\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The name of the security group in the specified AWS account.

\n " + } + } + } + }, + "IpRanges": { + "type": "list", + "documentation": "\n\t\t

One or more IP ranges.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an IP range.

\n ", + "members": { + "CidrIp": { + "type": "string", + "documentation": "\n\t\t

The CIDR range. You can either specify a CIDR range or a source security group, not both.

\n " + } + } + } + } + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Adds one or more egress rules to a security group for use with a VPC.\n\t\t\t\tSpecifically, this action permits instances to send traffic to one or more\n\t\t\t\tCIDR IP address ranges, or to one or more security groups\tfor the same VPC.

\n\t\t\t\n\t\t\t\t

You can have up to 50 rules per security group (covering both ingress and\n\t\t\t\t\tegress rules).

\n\t\t\t\n

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC.\n\t\t\t\tThis action doesn't apply to security groups for use in EC2-Classic. \n\t\t\t\tFor more information, see Security Groups for Your VPC in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.

\n

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or\n\t\t\t\ta source group. For the TCP and UDP protocols, you must also specify the destination\n\t\t\t\tport or port range. For the ICMP protocol, you must also specify the ICMP type and\n\t\t\t\tcode. You can use -1 for the type or code to mean all types or all codes.

\n

Rule changes are propagated to affected instances as quickly as possible. However,\n\t\t\t\ta small delay might occur.

\n \n \n Example 1\n This example request grants your security group with the ID sg-1a2b3c4d access to the\n\t\t\t\t\t192.0.2.0/24 and 198.51.100.0/24 address ranges on TCP port 80.\n https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupEgress\n&GroupId=sg-1a2b3c4d\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=80\n&IpPermissions.1.ToPort=80\n&IpPermissions.1.IpRanges.1.CidrIp=192.0.2.0/24\n&IpPermissions.1.IpRanges.2.CidrIp=198.51.100.0/24\n&AUTHPARAMS\n <AuthorizeSecurityGroupEgressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</AuthorizeSecurityGroupEgressResponse>\n \n \n Example 2\n This example request grants egress access from the security group with the ID sg-1a2b3c4d \n\t\t\t\t\tto the security group with the ID sg-9a8d7f5c on TCP port 1433.\n https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupEgress\n&GroupId=sg-1a2b3c4d\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=1433\n&IpPermissions.1.ToPort=1433\n&IpPermissions.1.Groups.1.GroupId=sg-9a8d7f5c\n&AUTHPARAMS\n <AuthorizeSecurityGroupEgressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</AuthorizeSecurityGroupEgressResponse>\n \n \n " + }, + "AuthorizeSecurityGroupIngress": { + "name": "AuthorizeSecurityGroupIngress", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

[EC2-Classic, default VPC] The name of the security group.

\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n " + }, + "SourceSecurityGroupName": { + "type": "string", + "documentation": "\n

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

\n " + }, + "SourceSecurityGroupOwnerId": { + "type": "string", + "documentation": "\n

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

\n " + }, + "IpProtocol": { + "type": "string", + "documentation": "\n

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

\n " + }, + "FromPort": { + "type": "integer", + "documentation": "\n

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.

\n " + }, + "ToPort": { + "type": "integer", + "documentation": "\n

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.

\n " + }, + "CidrIp": { + "type": "string", + "documentation": "\n

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

\n " + }, + "IpPermissions": { + "type": "list", + "documentation": "\n

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a security group rule.

\n ", + "members": { + "IpProtocol": { + "type": "string", + "documentation": "\n\t\t

The protocol.

\n\t\t

When you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.

\n " + }, + "FromPort": { + "type": "integer", + "documentation": "\n\t\t

The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.

\n " + }, + "ToPort": { + "type": "integer", + "documentation": "\n\t\t

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.

\n " + }, + "UserIdGroupPairs": { + "type": "list", + "documentation": "\n\t\t

One or more security group and AWS account ID pairs.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a security group and AWS account ID pair for EC2-Classic.

\n ", + "locationName": "Groups", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The ID of an AWS account.

\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The ID of the security group owned by the specified AWS account.

\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The name of the security group in the specified AWS account.

\n " + } + } + } + }, + "IpRanges": { + "type": "list", + "documentation": "\n\t\t

One or more IP ranges.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an IP range.

\n ", + "members": { + "CidrIp": { + "type": "string", + "documentation": "\n\t\t

The CIDR range. You can either specify a CIDR range or a source security group, not both.

\n " + } + } + } + } + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Adds one or more ingress rules to a security group.

\n\t\t\t\n\t\t\t\t

EC2-Classic: You can have up to 100 rules per group.

\n\t\t\t\t

EC2-VPC: You can have up to 50 rules per group (covering both ingress and\n\t\t\t\t\tegress rules).

\n\t\t\t\n

Rule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.

\n

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to\n\t\t\t\taccess a security group in your account, or gives one or more security groups\n\t\t\t\t(called the source groups) permission to access a security\n\t\t\t\tgroup for your account. A source group can be for your own AWS account, or another.

\n

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to\n\t\t\t\taccess a security group in your VPC, or gives one or more other security groups\n\t\t\t\t(called the source groups) permission to access a security\n\t\t\t\tgroup for your VPC. The security groups must all be for the same VPC.

\n \n \n Example 1\n This example request grants TCP port 80 access from the 192.0.2.0/24\n\t\t\t\t\tand 198.51.100.0/24 address ranges to the security group for EC2-Classic \n\t\t\t\t\tnamed websrv.\n https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress\n&GroupName=websrv\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=80\n&IpPermissions.1.ToPort=80\n&IpPermissions.1.IpRanges.1.CidrIp=192.0.2.0/24\n&IpPermissions.1.IpRanges.2.CidrIp=198.51.100.0/24\n&AUTHPARAMS\n \n \n Example 2\n This example request grants TCP port 80\n\t\t\t\t\taccess from the source group for EC2-Classic named OtherAccountGroup (in AWS\n\t\t\t\t\taccount 123456789012) to the security group for EC2-Classic named websrv.\n https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress\n&GroupName=websrv\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=80\n&IpPermissions.1.ToPort=80\n&IpPermissions.1.Groups.1.GroupName=OtherAccountGroup\n&IpPermissions.1.Groups.1.UserId=123456789012\n&AUTHPARAMS\n \n \n Example 3\n This example request grants TCP port\n\t\t\t\t\t80 access from the source group named OtherGroupInMyVPC\n\t\t\t\t\t(with the ID sg-2a2b3c4d) to the security group named VpcWebServers \n\t\t\t\t\t(with the ID sg-1a2b3c4d). In EC2-VPC, you must use the security group IDs in \n\t\t\t\t\ta request, not the security group names. In this example, your AWS account ID is 123456789012.\n https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress\n&GroupId=sg-1a2b3c4d\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=80\n&IpPermissions.1.ToPort=80\n&IpPermissions.1.Groups.1.GroupId=sg-2a2b3c4d\n&IpPermissions.1.Groups.1.UserId=123456789012\n&AUTHPARAMS\n \n \n Example 4\n This example request grants your local\n\t\t\t\t\tsystem the ability to use SSH (port 22) to connect to any instance in the security group\n\t\t\t\t\tnamed default.\n https://ec2.amazonaws.com/\n?Action=AuthorizeSecurityGroupIngress\n&GroupName=default\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=22\n&IpPermissions.1.ToPort=22\n&IpPermissions.1.IpRanges.1.CidrIp=your-local-system's-public-ip-address/32\n&AUTHPARAMS\n \n \n Example 5\n This example request grants your local system\n\t\t\t\t\tthe ability to use Remote Desktop (port 3389) to connect to any instance in the security group\n\t\t\t\t\tnamed default.\n https://ec2.amazonaws.com/\n?Action=AuthorizeSecurityGroupIngress\n&GroupName=default\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=3389\n&IpPermissions.1.ToPort=3389\n&IpPermissions.1.IpRanges.1.CidrIp=your-local-system's-public-ip-address/32\n \n \n " + }, + "BundleInstance": { + "name": "BundleInstance", + "input": { + "type": "structure", + "documentation": " \n ", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": " \n " + }, + "InstanceId": { + "type": "string", + "documentation": " \n

The ID of the instance to bundle.

\n " + }, + "Storage": { + "type": "structure", + "documentation": " \n

The bucket in which to store the AMI. You can specify a bucket that\n\t\t\t\tyou already own or a new bucket that Amazon EC2 creates on your behalf.\n\t\t\t\tIf you specify a bucket that belongs to someone else, Amazon EC2 returns\n\t\t\t\tan error.

\n ", + "members": { + "S3": { + "type": "structure", + "documentation": "\n

An Amazon S3 storage location.

\n ", + "members": { + "Bucket": { + "type": "string", + "documentation": "\n

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

\n " + }, + "Prefix": { + "type": "string", + "documentation": "\n

The beginning of the file name of the AMI.

\n " + }, + "AWSAccessKeyId": { + "type": "string", + "documentation": "\n

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.

\n " + }, + "UploadPolicy": { + "type": "blob", + "documentation": "\n

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

\n " + }, + "UploadPolicySignature": { + "type": "string", + "documentation": "\n

The signature of the Base64 encoded JSON document.

\n " + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": " \n ", + "members": { + "BundleTask": { + "type": "structure", + "documentation": " \n

Information about the bundle task.

\n ", + "locationName": "bundleInstanceTask", + "members": { + "InstanceId": { + "type": "string", + "documentation": " \n

The ID of the instance associated with this bundle task.

\n ", + "locationName": "instanceId" + }, + "BundleId": { + "type": "string", + "documentation": " \n

The ID for this bundle task.

\n ", + "locationName": "bundleId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ], + "documentation": " \n

The state of the task.

\n ", + "locationName": "state" + }, + "StartTime": { + "type": "timestamp", + "documentation": " \n

The time this task started.

\n ", + "locationName": "startTime" + }, + "UpdateTime": { + "type": "timestamp", + "documentation": " \n

The time of the most recent update for the task.

\n ", + "locationName": "updateTime" + }, + "Storage": { + "type": "structure", + "documentation": " \n

The Amazon S3 storage locations.

\n ", + "locationName": "storage", + "members": { + "S3": { + "type": "structure", + "documentation": "\n

An Amazon S3 storage location.

\n ", + "members": { + "Bucket": { + "type": "string", + "documentation": "\n

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

\n ", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "documentation": "\n

The beginning of the file name of the AMI.

\n ", + "locationName": "prefix" + }, + "AWSAccessKeyId": { + "type": "string", + "documentation": "\n

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.

\n " + }, + "UploadPolicy": { + "type": "string", + "documentation": "\n

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

\n ", + "locationName": "uploadPolicy" + }, + "UploadPolicySignature": { + "type": "string", + "documentation": "\n

The signature of the Base64 encoded JSON document.

\n ", + "locationName": "uploadPolicySignature" + } + } + } + } + }, + "Progress": { + "type": "string", + "documentation": " \n

The level of task completion, as a percent (for example, 20%).

\n ", + "locationName": "progress" + }, + "BundleTaskError": { + "type": "structure", + "documentation": " \n

If the task fails, a description of the error.

\n ", + "locationName": "error", + "members": { + "Code": { + "type": "string", + "documentation": " \n

The error code.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": " \n

The error message.

\n ", + "locationName": "message" + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": " \n

Bundles an Amazon instance store-backed Windows instance.

\n

During bundling, only the root device volume (C:\\) is bundled. Data on other\n\t\t\t\tinstance store volumes is not preserved.

\n \n

This procedure is not applicable for Linux/Unix instances or Windows instances\n that are backed by Amazon EBS.

\n\t\t\t\n

For more information, see Creating an Instance Store-Backed Windows AMI.

\n \n \n Example\n \n

This example request bundles the specified instance.

\n

Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.

\n \n https://ec2.amazonaws.com/?Action=BundleInstance\n&InstanceId=i-e468cd8d\n&Storage.S3.AWSAccessKeyId='AKIAIOSFODNN7EXAMPLE'\n&Storage.S3.Bucket=myawsbucket \n&Storage.S3.Prefix=winami\n&Storage.S3.UploadPolicy=eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MD\nlaIiwiY29uZGl0aW9ucyI6IFt7ImJ1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgI\niRrZXkiLCAibXktbmV3LWltYWdlIl0seyJhY2wiOiAiZWMyLWJ1bmRsZS1yZWFkIn1dfEXAMPLE\n&Storage.S3.UploadPolicySignature=fh5tyyyQD8W4COEthj3nlGNEXAMPLE \n&AUTHPARAMS\n <BundleInstanceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <bundleInstanceTask>\n <instanceId>i-12345678</instanceId>\n <bundleId>bun-c1a540a8</bundleId>\n <state>bundling</state>\n <startTime>2008-10-07T11:41:50.000Z</startTime>\n <updateTime>2008-10-07T11:51:50.000Z</updateTime>\n <progress>70%</progress>\n <storage>\n <S3>\n <bucket>myawsbucket</bucket>\n <prefix>winami</prefix>\n </S3>\n </storage>\n </bundleInstanceTask>\n</BundleInstanceResponse>\n \n \n " + }, + "CancelBundleTask": { + "name": "CancelBundleTask", + "input": { + "type": "structure", + "documentation": " \n ", + "required": [ + "BundleId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": " \n " + }, + "BundleId": { + "type": "string", + "documentation": " \n

The ID of the bundle task.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": " \n ", + "members": { + "BundleTask": { + "type": "structure", + "documentation": " \n

The bundle task.

\n ", + "locationName": "bundleInstanceTask", + "members": { + "InstanceId": { + "type": "string", + "documentation": " \n

The ID of the instance associated with this bundle task.

\n ", + "locationName": "instanceId" + }, + "BundleId": { + "type": "string", + "documentation": " \n

The ID for this bundle task.

\n ", + "locationName": "bundleId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ], + "documentation": " \n

The state of the task.

\n ", + "locationName": "state" + }, + "StartTime": { + "type": "timestamp", + "documentation": " \n

The time this task started.

\n ", + "locationName": "startTime" + }, + "UpdateTime": { + "type": "timestamp", + "documentation": " \n

The time of the most recent update for the task.

\n ", + "locationName": "updateTime" + }, + "Storage": { + "type": "structure", + "documentation": " \n

The Amazon S3 storage locations.

\n ", + "locationName": "storage", + "members": { + "S3": { + "type": "structure", + "documentation": "\n

An Amazon S3 storage location.

\n ", + "members": { + "Bucket": { + "type": "string", + "documentation": "\n

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

\n ", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "documentation": "\n

The beginning of the file name of the AMI.

\n ", + "locationName": "prefix" + }, + "AWSAccessKeyId": { + "type": "string", + "documentation": "\n

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.

\n " + }, + "UploadPolicy": { + "type": "string", + "documentation": "\n

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

\n ", + "locationName": "uploadPolicy" + }, + "UploadPolicySignature": { + "type": "string", + "documentation": "\n

The signature of the Base64 encoded JSON document.

\n ", + "locationName": "uploadPolicySignature" + } + } + } + } + }, + "Progress": { + "type": "string", + "documentation": " \n

The level of task completion, as a percent (for example, 20%).

\n ", + "locationName": "progress" + }, + "BundleTaskError": { + "type": "structure", + "documentation": " \n

If the task fails, a description of the error.

\n ", + "locationName": "error", + "members": { + "Code": { + "type": "string", + "documentation": " \n

The error code.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": " \n

The error message.

\n ", + "locationName": "message" + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": " \n

Cancels a bundling operation for an instance store-backed Windows instance.

\n \n \n Example\n This example request cancels the specified bundle task.\n https://ec2.amazonaws.com/?Action=CancelBundleTask\n&BundleId=bun-cla322b9\n&AUTHPARAMS\n <CancelBundleTaskResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <bundleInstanceTask>\n <instanceId>i-12345678</instanceId>\n <bundleId>bun-cla322b9</bundleId>\n <state>canceling</state>\n <startTime>2008-10-07T11:41:50.000Z</startTime>\n <updateTime>2008-10-07T11:51:50.000Z</updateTime>\n <progress>20%</progress>\n <storage>\n <S3>\n <bucket>myawsbucket</bucket>\n <prefix>my-new-image</prefix>\n </S3>\n </storage>\n </bundleInstanceTask>\n</CancelBundleTaskResponse>\n \n \n " + }, + "CancelConversionTask": { + "name": "CancelConversionTask", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ConversionTaskId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ConversionTaskId": { + "type": "string", + "documentation": "\n

The ID of the conversion task.

\n " + }, + "ReasonMessage": { + "type": "string", + "documentation": "\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Cancels an active conversion task. The task can be the import of an instance or volume. The\n action removes all artifacts of the conversion, including a partially uploaded volume or\n instance. If the conversion is complete or is in the process of transferring the final disk\n image, the command fails and returns an exception.

\n \n

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon\n EC2 in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request cancels the conversion task with the ID import-i-fh95npoc. \n https://ec2.amazonaws.com/?Action=CancelConversionTask\n&ConversionTaskId=import-i-fh95npoc\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE\n true\n\n \n \n " + }, + "CancelExportTask": { + "name": "CancelExportTask", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ExportTaskId" + ], + "members": { + "ExportTaskId": { + "type": "string", + "documentation": "\n

The ID of the export task. This is the ID\n returned by CreateInstanceExportTask.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Cancels an active export task. The request removes all artifacts of the export,\n including any partially-created Amazon S3 objects. If the export task is complete or\n is in the process of transferring the final disk image, the command fails and\n returns an error.

\n \n \n Example\n This example request cancels the export task with the ID export-i-1234wxyz. \n https://ec2.amazonaws.com/?Action=CancelExportTask\n &exportTaskId=export-i-1234wxyz\n &AUTHPARAMS\n \n59dbff89-35bd-4eac-99ed-be587EXAMPLE\ntrue\n\n \n \n " + }, + "CancelReservedInstancesListing": { + "name": "CancelReservedInstancesListing", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ReservedInstancesListingId" + ], + "members": { + "ReservedInstancesListingId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance listing.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesListings": { + "type": "list", + "documentation": "\n

The Reserved Instance listing.

\n ", + "locationName": "reservedInstancesListingsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance listing.

\n ", + "locationName": "item", + "members": { + "ReservedInstancesListingId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance listing.

\n ", + "locationName": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance.

\n ", + "locationName": "reservedInstancesId" + }, + "CreateDate": { + "type": "timestamp", + "documentation": "\n

The time the listing was created.

\n ", + "locationName": "createDate" + }, + "UpdateDate": { + "type": "timestamp", + "documentation": "\n

The last modified timestamp of the listing.

\n ", + "locationName": "updateDate" + }, + "Status": { + "type": "string", + "enum": [ + "active", + "pending", + "cancelled", + "closed" + ], + "documentation": "\n

The status of the Reserved Instance listing.

\n ", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.

\n ", + "locationName": "statusMessage" + }, + "InstanceCounts": { + "type": "list", + "documentation": "\n

The number of instances in this state.

\n ", + "locationName": "instanceCounts", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance listing state.

\n ", + "locationName": "item", + "members": { + "State": { + "type": "string", + "enum": [ + "available", + "sold", + "cancelled", + "pending" + ], + "documentation": "\n

The states of the listed Reserved Instances.

\n ", + "locationName": "state" + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

he number of listed Reserved Instances in the state specified by the state.

\n ", + "locationName": "instanceCount" + } + } + } + }, + "PriceSchedules": { + "type": "list", + "documentation": "\n

The price of the Reserved Instance listing.

\n ", + "locationName": "priceSchedules", + "member": { + "type": "structure", + "documentation": "\n

Describes the price for a Reserved Instance.

\n ", + "locationName": "item", + "members": { + "Term": { + "type": "long", + "documentation": "\n

The number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.

\n ", + "locationName": "term" + }, + "Price": { + "type": "double", + "documentation": "\n

The fixed price for the term.

\n ", + "locationName": "price" + }, + "CurrencyCode": { + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\n

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

\n ", + "locationName": "currencyCode" + }, + "Active": { + "type": "boolean", + "documentation": "\n

The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.

\n

A specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.

\n ", + "locationName": "active" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "ClientToken": { + "type": "string", + "documentation": "\n

The idempotency token you provided when you created the listing.

\n ", + "locationName": "clientToken" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

\n

For more information, see \n Reserved Instance Marketplace \n in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request cancels a Reserved Instance listing in the Reserved Instance Marketplace.\n https://ec2.amazonaws.com/?Action=CancelReservedInstancesListing\n&ReservedInstancesListingId=3ebe97b5-f273-43b6-a204-7a18cEXAMPLE\n&AUTHPARAMS\n \n bec2cf62-98ef-434a-8a15-886fcexample\n \n \n 3ebe97b5-f273-43b6-a204-7a18cEXAMPLE\n e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE\n 2012-07-12T16:55:28.000Z\n 2012-07-12T16:55:28.000Z\n cancelled\n CANCELLED\n \n \n Available\n 0\n \n \n Sold\n 0\n \n \n Cancelled\n 1\n \n \n Pending\n 0\n \n \n \n \n 5\n 166.64\n USD\n false\n \n \n 4\n 133.32\n USD\n false\n \n \n 3\n 99.99\n USD\n false\n \n \n 2\n 66.66\n USD\n false\n \n \n 1\n 33.33\n USD\n false\n \n \n \n XqJIt1342112125076\n \n \n\n \n \n " + }, + "CancelSpotInstanceRequests": { + "name": "CancelSpotInstanceRequests", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SpotInstanceRequestIds" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SpotInstanceRequestIds": { + "type": "list", + "documentation": "\n

One or more Spot Instance request IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SpotInstanceRequestId" + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "CancelledSpotInstanceRequests": { + "type": "list", + "documentation": "\n

One or more Spot Instance requests.

\n ", + "locationName": "spotInstanceRequestSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a request to cancel a Spot Instance.

\n ", + "locationName": "item", + "members": { + "SpotInstanceRequestId": { + "type": "string", + "documentation": "\n

The ID of the Spot Instance request.

\n ", + "locationName": "spotInstanceRequestId" + }, + "State": { + "type": "string", + "enum": [ + "active", + "open", + "closed", + "cancelled", + "completed" + ], + "documentation": "\n

The state of the Spot Instance request.

\n ", + "locationName": "state" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Cancels one or more Spot Instance requests. Spot Instances are instances that\n\t\t\t\tAmazon EC2 starts on your behalf when the maximum price that you specify exceeds the\n\t\t\t\tcurrent Spot Price. Amazon EC2 periodically sets the Spot Price based on available\n\t\t\t\tSpot Instance capacity and current Spot Instance requests. For more information\n\t\t\t\tabout Spot Instances, see Spot\n\t\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.

\n \n

Canceling a Spot Instance request does not terminate running Spot Instances\n\t\t\t\t\tassociated with the request.

\n \n \n \n Example\n This example cancels the specified Spot Instance request.\n https://ec2.amazonaws.com/?Action=CancelSpotInstanceRequests\n&SpotInstanceRequestId.1=sir-1a2b3c4d\n&AUTHPARAMS\n <CancelSpotInstanceRequestsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <spotInstanceRequestSet>\n <item>\n <spotInstanceRequestId>sir-1a2b3c4d</spotInstanceRequestId>\n <state>cancelled</state>\n </item>\n </spotInstanceRequestSet>\n</CancelSpotInstanceRequestsResponse>\n \n \n " + }, + "ConfirmProductInstance": { + "name": "ConfirmProductInstance", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ProductCode", + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ProductCode": { + "type": "string", + "documentation": "\n

The product code. This must be an Amazon DevPay product code that you own.

\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the instance owner. This is only present if the product code\n\t\t\t\tis attached to the instance.

\n ", + "locationName": "ownerId" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Determines whether a product code is associated with an instance. This action can\n\t\t\t\tonly be used by the owner of the product code. It is useful when a product code\n\t\t\t\towner needs to verify whether another user's instance is eligible for\n\t\t\t\tsupport.

\n \n \n Example\n This example determines whether the specified product code is associated with the\n\t\t\t\t\tspecified instance.\n https://ec2.amazonaws.com/?Action=ConfirmProductInstance\n&ProductCode=774F4FF8\n&InstanceId=i-10a64379\n&AUTHPARAMS\n <ConfirmProductInstanceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n <ownerId>111122223333</ownerId>\n</ConfirmProductInstanceResponse>\n \n \n " + }, + "CopyImage": { + "name": "CopyImage", + "input": { + "type": "structure", + "documentation": " \n ", + "required": [ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": " \n " + }, + "SourceRegion": { + "type": "string", + "documentation": "\n

The name of the region that contains the AMI to copy.

\n " + }, + "SourceImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI to copy.

\n " + }, + "Name": { + "type": "string", + "documentation": "\n

The name of the new AMI in the destination region.

\n " + }, + "Description": { + "type": "string", + "documentation": " \n

A description for the new AMI in the destination region.

\n " + }, + "ClientToken": { + "type": "string", + "documentation": " \n

Unique, case-sensitive identifier you provide to ensure\n\t\t\t\tidempotency of the request. For more information, see How to Ensure Idempotency in the \n\t\t\t Amazon Elastic Compute Cloud User Guide.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": " \n ", + "members": { + "ImageId": { + "type": "string", + "documentation": " \n

The ID of the new AMI.

\n ", + "locationName": "imageId" + } + } + }, + "errors": [ + + ], + "documentation": " \n

Initiates the copy of an AMI from the specified source region to the region in which the\n request was made. You specify the destination region by using its endpoint when making the\n request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.

\n

For more information, see Copying AMIs\n in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request copies the AMI in us-west-2 with the ID ami-1a2b3c4d,\n\t\t\t\t\tnaming the new AMI My-Standard-AMI.\n https://ec2.amazonaws.com/?Action=CopyImage\n&SourceRegion=us-west-2\n&SourceImageId=ami-1a2b3c4d \n&Name=My-Standard-AMI\n&Description=This%20is%20the%20new%20version%20of%20My-Standard-AMI \n&ClientToken=550e8400-e29b-41d4-a716-446655440000\n&AUTHPARAMS\n <CopyImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>60bc441d-fa2c-494d-b155-5d6a3EXAMPLE</requestId>\n <imageId>ami-4d3c2b1a</imageId>\n</CopyImageResponse>\n \n \n " + }, + "CopySnapshot": { + "name": "CopySnapshot", + "input": { + "type": "structure", + "documentation": "\n\n ", + "required": [ + "SourceRegion", + "SourceSnapshotId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SourceRegion": { + "type": "string", + "documentation": "\n

The ID of the region that contains the snapshot to be copied.

\n " + }, + "SourceSnapshotId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS snapshot to copy.

\n " + }, + "Description": { + "type": "string", + "documentation": "\n

A description for the new Amazon EBS snapshot.

\n " + }, + "DestinationRegion": { + "type": "string", + "documentation": "\n

The destination region of the snapshot copy operation. This parameter is required in the\n PresignedUrl.

\n " + }, + "PresignedUrl": { + "type": "string", + "documentation": "\n

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only\n required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an\n optional parameter in all other cases. The PresignedUrl should use the snapshot\n source endpoint, the CopySnapshot action, and include the\n SourceRegion, SourceSnapshotId, and DestinationRegion\n parameters. The PresignedUrl must be signed using AWS Signature Version 4.\n Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the\n same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the\n Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause\n the copy operation to fail asynchronously, and the snapshot will move to an error\n state.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the new snapshot.

\n ", + "locationName": "snapshotId" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the\n snapshot within the same region or from one region to another. You can use the snapshot to\n create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional\n endpoint that you send the HTTP request to.

\n

Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain\n unencrypted.

\n

For more information, see Copying an Amazon EBS Snapshot in the\n Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request copies the snapshot in the us-west-1 region with the ID\n snap-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=CopySnapshot\n&SourceRegion=us-west-1\n&SourceSnapshotId=snap-1a2b3c4d\n&Description=My_snapshot\n&AUTHPARAMS\n <CopySnapshotResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>60bc441d-fa2c-494d-b155-5d6a3EXAMPLE</requestId>\n <snapshotId>snap-2a2b3c4d</snapshotId>\n</CopySnapshotResponse>\n \n \n \n " + }, + "CreateCustomerGateway": { + "name": "CreateCustomerGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Type", + "PublicIp", + "BgpAsn" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Type": { + "type": "string", + "enum": [ + "ipsec.1" + ], + "documentation": "\n\t\t

The type of VPN connection that this customer gateway supports.

\n " + }, + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The Internet-routable IP address for the customer gateway's outside\n\t\t\t\tinterface. The address must be static.

\n ", + "locationName": "IpAddress" + }, + "BgpAsn": { + "type": "integer", + "documentation": "\n\t\t

For devices that support BGP, the customer gateway's BGP ASN.

\n\t\t

Default: 65000

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "CustomerGateway": { + "type": "structure", + "documentation": "\n\t\t

Information about the customer gateway.

\n ", + "locationName": "customerGateway", + "members": { + "CustomerGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the customer gateway.

\n ", + "locationName": "customerGatewayId" + }, + "State": { + "type": "string", + "documentation": "\n\t\t

The current state of the customer gateway.

\n ", + "locationName": "state" + }, + "Type": { + "type": "string", + "documentation": "\n\t\t

The type of VPN connection the customer gateway supports.

\n ", + "locationName": "type" + }, + "IpAddress": { + "type": "string", + "documentation": "\n\t\t

The Internet-routable IP address of the customer gateway's outside interface.

\n ", + "locationName": "ipAddress" + }, + "BgpAsn": { + "type": "string", + "documentation": "\n\t\t

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

\n ", + "locationName": "bgpAsn" + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the customer gateway.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Provides information to AWS about your VPN customer gateway device. The customer\n\t\t\t\tgateway is the appliance at your end of the VPN connection. (The device on the AWS\n\t\t\t\tside of the VPN connection is the virtual private gateway.) You must provide the\n\t\t\t\tInternet-routable IP address of the customer gateway's external interface. The IP\n\t\t\t\taddress must be static and can't be behind a device performing network address\n\t\t\t\ttranslation (NAT).

\n\t\t

For devices that use Border Gateway Protocol (BGP), you can also provide the\n\t\t\t\tdevice's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to\n\t\t\t\tyour network. If you don't have an ASN already, you can use a private ASN (in the\n\t\t\t\t64512 - 65534 range).

\n\t\t\t\n\t\t\t\t

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the\n\t\t\t\t\texception of 7224, which is reserved in the us-east-1 region, and 9059, which is\n\t\t\t\t\treserved in the eu-west-1 region.

\n\t\t\t\n\t\t

For more information about VPN customer gateways, see\n\t\t\t\t\tAdding a Hardware\n\t\t\t\t\tVirtual Private Gateway to Your VPC in the\n\t\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example passes information to AWS about the customer gateway with the IP\n\t\t\t\t\taddress 12.1.2.3 and BGP ASN 65534.\n https://ec2.amazonaws.com/?Action=CreateCustomerGateway\n&Type=ipsec.1\n&IpAddress=12.1.2.3\n&BgpAsn=65534\n&AUTHPARAMS\n <CreateCustomerGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <customerGateway>\t\t\n <customerGatewayId>cgw-b4dc3961</customerGatewayId>\n <state>pending</state>\n <type>ipsec.1</type>\n <ipAddress>12.1.2.3</ipAddress>\n <bgpAsn>65534</bgpAsn>\n <tagSet/>\n </customerGateway>\n</CreateCustomerGatewayResponse>\n \n \n " + }, + "CreateDhcpOptions": { + "name": "CreateDhcpOptions", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "DhcpConfigurations" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "DhcpConfigurations": { + "type": "list", + "documentation": "\n\t\t

A DHCP configuration option.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a DHCP configuration option.

\n ", + "locationName": "DhcpConfiguration", + "members": { + "Key": { + "type": "string", + "documentation": "\n\t\t

The name of a DHCP option.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n\t\t

One or more values for the DHCP option.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "DhcpOptions": { + "type": "structure", + "documentation": "\n\t\t

A set of DHCP options.

\n ", + "locationName": "dhcpOptions", + "members": { + "DhcpOptionsId": { + "type": "string", + "documentation": "\n\t\t

The ID of the set of DHCP options.

\n ", + "locationName": "dhcpOptionsId" + }, + "DhcpConfigurations": { + "type": "list", + "documentation": "\n\t\t

One or more DHCP options in the set.

\n ", + "locationName": "dhcpConfigurationSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a DHCP configuration option.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n\t\t

The name of a DHCP option.

\n ", + "locationName": "key" + }, + "Values": { + "type": "list", + "documentation": "\n\t\t

One or more values for the DHCP option.

\n ", + "locationName": "valueSet", + "member": { + "type": "string", + "documentation": null, + "locationName": "item" + } + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the DHCP options set.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.

\n \n

For more information about DHCP options, see DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example creates a set of DHCP options with a domain name\n example.com and two DNS servers (10.2.5.1 and\n 10.2.5.2). The DNS servers' IP addresses are specified in a single\n parameter, separated by commas, to preserve the order in which they are\n specified.\n https://ec2.amazonaws.com/?Action=CreateDhcpOptions \n&DhcpConfiguration.1.Key=domain-name\n&DhcpConfiguration.1.Value.1=example.com\n&DhcpConfiguration.2.Key=domain-name-servers\n&DhcpConfiguration.2.Value.1=10.2.5.1,10.2.5.2\n&AUTHPARAMS\n <CreateDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <dhcpOptions>\n <dhcpOptionsId>dopt-7a8b9c2d</dhcpOptionsId>\n <dhcpConfigurationSet>\n <item>\n <key>domain-name</key>\n <valueSet>\n <item>\n <value>example.com</value>\n </item>\n </valueSet>\n </item>\n <item>\n <key>domain-name-servers</key>\n <valueSet>\n <item>\n <value>10.2.5.1</value>\n </item>\n <item>\n <value>10.2.5.2</value>\n </item>\n </valueSet>\n </item>\n </dhcpConfigurationSet>\n <tagSet/>\n </dhcpOptions>\n</CreateDhcpOptionsResponse>\n \n \n " + }, + "CreateImage": { + "name": "CreateImage", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceId", + "Name" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + }, + "Name": { + "type": "string", + "documentation": "\n

A name for the new image.

\n

Constraints: 3-128 alphanumeric characters, parenthesis (()), periods (.), slashes\n\t\t\t\t(/), dashes (-), or underscores(_)

\n " + }, + "Description": { + "type": "string", + "documentation": "\n

A description for the new image.

\n " + }, + "NoReboot": { + "type": "boolean", + "documentation": "\n

By default, this parameter is set to false, which means\n\t\t\t\tAmazon EC2 attempts to shut down the instance cleanly before image\n\t\t\t\tcreation and then reboots the instance. When the parameter is set to\n\t\t\t\ttrue, Amazon EC2 doesn't shut down the instance before\n\t\t\t\tcreating the image. When this option is used, file system integrity on\n\t\t\t\tthe created image can't be guaranteed.

\n " + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

Information about one or more block device mappings.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "BlockDeviceMapping", + "members": { + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n " + }, + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n " + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n " + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

\n

Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.

\n " + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n " + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.

\n

Default: standard

\n " + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the\n volume supports.

\n

Constraint: Range is 100 to 4000.

\n

Condition: Required when the volume type is io1; not used with\n standard or gp2 volumes.

\n " + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is encrypted.

\n " + } + } + }, + "NoDevice": { + "type": "string", + "documentation": "\n

Suppresses the specified device included in the block device mapping of the AMI.

\n " + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the new AMI.

\n ", + "locationName": "imageId" + } + } + }, + "errors": [ + + ], + "documentation": " \n

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either\n\t\t\t\trunning or stopped.

\n

If you customized your instance with instance store volumes or EBS volumes\n\t\t\t\tin addition to the root device volume, the new AMI contains block device mapping\n\t\t\t\tinformation for those volumes. When you launch an instance from this new AMI,\n\t\t\t\tthe instance automatically launches with those additional volumes.

\n

For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request creates an AMI from the specified instance.\n https://ec2.amazonaws.com/?Action=CreateImage\n&Description=Standard+Web+Server+v1.0\n&InstanceId=i-10a64379\n&Name=standard-web-server-v1.0\n&AUTHPARAMS\n <CreateImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <imageId>ami-4fa54026</imageId>\n</CreateImageResponse>\n \n \n " + }, + "CreateInstanceExportTask": { + "name": "CreateInstanceExportTask", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceId" + ], + "members": { + "Description": { + "type": "string", + "documentation": "\n

A description for the conversion task or the resource being\n exported. The maximum length is 255 bytes.

\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + }, + "TargetEnvironment": { + "type": "string", + "enum": [ + "citrix", + "vmware", + "microsoft" + ], + "documentation": "\n

The target virtualization environment.

\n " + }, + "ExportToS3Task": { + "type": "structure", + "documentation": "\n ", + "locationName": "ExportToS3", + "members": { + "DiskImageFormat": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n " + }, + "ContainerFormat": { + "type": "string", + "enum": [ + "ova" + ], + "documentation": "\n " + }, + "S3Bucket": { + "type": "string", + "documentation": "\n " + }, + "S3Prefix": { + "type": "string", + "documentation": "\n

The image is written to a single object in the Amazon S3 bucket at the S3 key\n s3prefix + exportTaskId + '.' + diskImageFormat.

\n " + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ExportTask": { + "type": "structure", + "documentation": "\n ", + "locationName": "exportTask", + "members": { + "ExportTaskId": { + "type": "string", + "documentation": "\n

The ID of the export task.

\n ", + "locationName": "exportTaskId" + }, + "Description": { + "type": "string", + "documentation": "\n

A description of the resource being exported.

\n ", + "locationName": "description" + }, + "State": { + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\n

The state of the conversion task.

\n ", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The status message related to the export task.

\n ", + "locationName": "statusMessage" + }, + "InstanceExportDetails": { + "type": "structure", + "documentation": "\n

The instance being exported.

\n ", + "locationName": "instanceExport", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the resource being exported.

\n ", + "locationName": "instanceId" + }, + "TargetEnvironment": { + "type": "string", + "enum": [ + "citrix", + "vmware", + "microsoft" + ], + "documentation": "\n

The target virtualization environment.

\n ", + "locationName": "targetEnvironment" + } + } + }, + "ExportToS3Task": { + "type": "structure", + "documentation": "\n ", + "locationName": "exportToS3", + "members": { + "DiskImageFormat": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The format for the exported image.

\n ", + "locationName": "diskImageFormat" + }, + "ContainerFormat": { + "type": "string", + "enum": [ + "ova" + ], + "documentation": "\n

The container format used to combine disk images with metadata (such as OVF). If absent, only\n the disk image is exported.

\n ", + "locationName": "containerFormat" + }, + "S3Bucket": { + "type": "string", + "documentation": "\n

The Amazon S3 bucket for the destination image. The destination bucket must\n exist and grant WRITE and READ_ACL permissions to the AWS account\n vm-import-export@amazon.com.

\n ", + "locationName": "s3Bucket" + }, + "S3Key": { + "type": "string", + "documentation": "\n ", + "locationName": "s3Key" + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Exports a running or stopped instance to an Amazon S3 bucket.

\n \n

For information about the supported operating systems, image formats, and known limitations for the\n types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request creates an Export VM task that makes a Windows instance available\n as an OVA. \n https://ec2.amazonaws.com/?Action=CreateInstanceExportTask\n &Description=Example%20for%20docs\n &InstanceId=i-12345678\n &TargetEnvironment=VMWare\n &ExportToS3.DiskImageFormat=VMDK\n &ExportToS3.ContainerFormat=OVA\n &ExportToS3.S3bucket=my-bucket-for-exported-vm\n &ExportToS3.S3prefix=my-exports/\n &AUTHPARAMS\n <CreateInstanceExportTaskResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <exportTask>\n <exportTaskId>export-i-1234wxyz</exportTaskId>\n <description>Example for docs</description>\n <state>active</state>\n <statusMessage>Running</statusMessage>\n <instanceExport>\n <instanceId>i-12345678</instanceId>\n <targetEnvironment>VMWare</targetEnvironment>\n </instanceExport>\n <exportToS3>\n <diskImageFormat>VMDK</diskImageFormat>\n <containerFormat>OVA</containerFormat>\n <s3Bucket>my-bucket-for-exported-vm</s3Bucket>\n <s3Key>my-exports/ export-i-1234wxyz .ova</s3Key>\n </exportToS3>\n </exportTask>\n </CreateInstanceExportTaskResponse>\n \n \n " + }, + "CreateInternetGateway": { + "name": "CreateInternetGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "InternetGateway": { + "type": "structure", + "documentation": "\n\t\t

Information about the Internet gateway.

\n ", + "locationName": "internetGateway", + "members": { + "InternetGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Internet gateway.

\n ", + "locationName": "internetGatewayId" + }, + "Attachments": { + "type": "list", + "documentation": "\n\t\t

Any VPCs attached to the Internet gateway.

\n ", + "locationName": "attachmentSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes the attachment of a VPC to an Internet gateway.

\n ", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The current state of the attachment.

\n ", + "locationName": "state" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the Internet gateway.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Creates an Internet gateway for use with a VPC. After creating the Internet\n\t\t\t\tgateway, you attach it to a VPC using AttachInternetGateway.

\n\t\t

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example creates an Internet gateway.\n https://ec2.amazonaws.com/?Action=CreateInternetGateway\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n igw-eaad4883\n \n \n \n\n \n \n " + }, + "CreateKeyPair": { + "name": "CreateKeyPair", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "KeyName" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "KeyName": { + "type": "string", + "documentation": "\n

A unique name for the key pair.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair.

\n ", + "locationName": "keyName" + }, + "KeyFingerprint": { + "type": "string", + "documentation": "\n

The SHA-1 digest of the DER encoded private key.

\n ", + "locationName": "keyFingerprint" + }, + "KeyMaterial": { + "type": "string", + "documentation": "\n

An unencrypted PEM encoded RSA private key.

\n ", + "locationName": "keyMaterial" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key\n\t\t\t\tand displays the private key for you to save to a file. The private key is\n\t\t\t\treturned as an unencrypted PEM encoded PKCS#8 private key. If a key with the\n\t\t\t\tspecified name already exists, Amazon EC2 returns an error.

\n

You can have up to five thousand key pairs per region.

\n

For more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request creates a key pair named my-key-pair.\n https://ec2.amazonaws.com/?Action=CreateKeyPair\n&KeyName=my-key-pair\n&AUTHPARAMS\n <CreateKeyPairResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n my-key-pair\n \n 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f\n \n ---- BEGIN RSA PRIVATE KEY ----\nMIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6\nb24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd\nBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN\nMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD\nVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z\nb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt\nYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ\n21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T\nrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE\nIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4\nnUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb\nFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb\nNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE\n-----END RSA PRIVATE KEY-----\n\n \n \n Saving the File\n Create a file named my-key-pair.pem and paste\n\t\t\t\t\tthe entire key from the response into this file.\n\t\t\t\t\tKeep this file in a safe place; it is required to decrypt login information \n\t\t\t\t\twhen you connect to an instance that you launched using this key pair.\n\t\t\t\t\tIf you're using an SSH client on a Linux computer to connect to your instance, \n\t\t\t\t\tuse the following command to set the permissions of your private key file so \n\t\t\t\t\tthat only you can read it.\n chmod 400 my-key-pair.pem\n \n \n " + }, + "CreateNetworkAcl": { + "name": "CreateNetworkAcl", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "NetworkAcl": { + "type": "structure", + "documentation": "\n\t\t

Information about the network ACL.

\n ", + "locationName": "networkAcl", + "members": { + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network ACL.

\n ", + "locationName": "networkAclId" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC for the network ACL.

\n ", + "locationName": "vpcId" + }, + "IsDefault": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this is the default network ACL for the VPC.

\n ", + "locationName": "default" + }, + "Entries": { + "type": "list", + "documentation": "\n\t\t

One or more entries (rules) in the network ACL.

\n ", + "locationName": "entrySet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an entry in a network ACL.

\n ", + "locationName": "item", + "members": { + "RuleNumber": { + "type": "integer", + "documentation": "\n\t\t

The rule number for the entry. ACL entries are processed in ascending order by rule number.

\n ", + "locationName": "ruleNumber" + }, + "Protocol": { + "type": "string", + "documentation": "\n\t\t

The protocol. A value of -1 means all protocols.

\n ", + "locationName": "protocol" + }, + "RuleAction": { + "type": "string", + "enum": [ + "allow", + "deny" + ], + "documentation": "\n\t\t

Indicates whether to allow or deny the traffic that matches the rule.

\n ", + "locationName": "ruleAction" + }, + "Egress": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

\n ", + "locationName": "egress" + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The network range to allow or deny, in CIDR notation.

\n ", + "locationName": "cidrBlock" + }, + "IcmpTypeCode": { + "type": "structure", + "documentation": "\n\t\t

ICMP protocol: The ICMP type and code.

\n ", + "locationName": "icmpTypeCode", + "members": { + "Type": { + "type": "integer", + "documentation": "\n\t\t

The ICMP code. A value of -1 means all codes for the specified ICMP type.

\n ", + "locationName": "type" + }, + "Code": { + "type": "integer", + "documentation": "\n\t\t

The ICMP type. A value of -1 means all types.

\n ", + "locationName": "code" + } + } + }, + "PortRange": { + "type": "structure", + "documentation": "\n\t\t

TCP or UDP protocols: The range of ports the rule applies to.

\n ", + "locationName": "portRange", + "members": { + "From": { + "type": "integer", + "documentation": "\n\t\t

The first port in the range.

\n ", + "locationName": "from" + }, + "To": { + "type": "integer", + "documentation": "\n\t\t

The last port in the range.

\n ", + "locationName": "to" + } + } + } + } + } + }, + "Associations": { + "type": "list", + "documentation": "\n\t\t

Any associations between the network ACL and one or more subnets

\n ", + "locationName": "associationSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an association between a network ACL and a subnet.

\n ", + "locationName": "item", + "members": { + "NetworkAclAssociationId": { + "type": "string", + "documentation": "\n\t\t

The ID of the association between a network ACL and a subnet.

\n ", + "locationName": "networkAclAssociationId" + }, + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network ACL.

\n ", + "locationName": "networkAclId" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the network ACL.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition\n\t\t\t\tto security groups) for the instances in your VPC.

\n\t\t

For more information about network ACLs, see Network ACLs in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example creates a network ACL in the specified VPC. \n\t\t\t\t\tThe response includes a default entry for egress, and another for ingress,\n\t\t\t\t\teach with a very high rule number. These are the last entries we process to\n\t\t\t\t\tdecide whether traffic is allowed in or out of an associated subnet. If the\n\t\t\t\t\ttraffic doesn't match any rules with a lower rule number, then these default\n\t\t\t\t\tentries ultimately deny the traffic.\n https://ec2.amazonaws.com/?Action=CreateNetworkAcl\n&VpcId=vpc-11ad4878\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n acl-5fb85d36\n vpc-11ad4878\n false\n \n \n 32767\n all\n deny\n true\n 0.0.0.0/0\n \n \n 32767\n all\n deny\n false\n 0.0.0.0/0\n \n \n \n \n \n\n \n \n " + }, + "CreateNetworkAclEntry": { + "name": "CreateNetworkAclEntry", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the ACL.

\n " + }, + "RuleNumber": { + "type": "integer", + "documentation": "\n\t\t

The rule number for the entry (for example, 100). ACL\n\t\t\t\tentries are processed in ascending order by rule number.

\n

Constraints: Positive integer from 1 to 32766

\n " + }, + "Protocol": { + "type": "string", + "documentation": "\n\t\t

The protocol. A value of -1 means all protocols.

\n " + }, + "RuleAction": { + "type": "string", + "enum": [ + "allow", + "deny" + ], + "documentation": "\n\t\t

Indicates whether to allow or deny the traffic that matches the rule.

\n " + }, + "Egress": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

\n " + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The network range to allow or deny, in CIDR notation.

\n " + }, + "IcmpTypeCode": { + "type": "structure", + "documentation": "\n\t\t

ICMP protocol: The ICMP type and code.

\n ", + "locationName": "Icmp", + "members": { + "Type": { + "type": "integer", + "documentation": "\n\t\t

The ICMP code. A value of -1 means all codes for the specified ICMP type.

\n " + }, + "Code": { + "type": "integer", + "documentation": "\n\t\t

The ICMP type. A value of -1 means all types.

\n " + } + } + }, + "PortRange": { + "type": "structure", + "documentation": "\n\t\t

TCP or UDP protocols: The range of ports the rule applies to.

\n ", + "members": { + "From": { + "type": "integer", + "documentation": "\n\t\t

The first port in the range.

\n " + }, + "To": { + "type": "integer", + "documentation": "\n\t\t

The last port in the range.

\n " + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Creates an entry (a rule) in a network ACL with the specified rule number. Each\n\t\t\t\tnetwork ACL has a set of numbered ingress rules and a separate set of numbered\n\t\t\t\tegress rules. When determining whether a packet should be allowed in or out of a\n\t\t\t\tsubnet associated with the ACL, we process the entries in the ACL according to the\n\t\t\t\trule numbers, in ascending order. Each network ACL has a set of ingress rules and a\n\t\t\t\tseparate set of egress rules.

\n\t\t

We recommend that you leave room between the rule numbers (for example,\n\t\t\t\t100, 110, 120, ...), and not number them one right after the other (for\n\t\t\t\texample, 101, 102, 103, ...). This makes it easier to add a rule between\n\t\t\t\texisting ones without having to renumber the rules.

\n\t\t

After you add an entry, you can't modify it; you must either replace it, or create\n\t\t\t\tan entry and delete the old one.

\n\t\t

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example creates an entry with rule number 110 in the network ACL with the ID\n\t\t\t\t\tacl-2cb85d45. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP\n\t\t\t\t\tport 53 into any associated subnet.\n https://ec2.amazonaws.com/?Action=CreateNetworkAclEntry\n&NetworkAclId=acl-2cb85d45\n&RuleNumber=110\n&Protocol=udp\n&RuleAction=allow\n&Egress=false\n&CidrBlock=0.0.0.0/0\n&PortRange.From=53\n&PortRange.To=53\n&AUTHPARAMS\n <CreateNetworkAclEntryResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</CreateNetworkAclEntryResponse>\n \n \n " + }, + "CreateNetworkInterface": { + "name": "CreateNetworkInterface", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SubnetId" + ], + "members": { + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet to associate with the network interface.

\n " + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

A description for the network interface.

\n " + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The primary private IP address of the network interface. If you don't specify an IP\n\t\t\t\taddress, Amazon EC2 selects one for you from the subnet range.

\n " + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

The IDs of one or more security groups.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SecurityGroupId" + } + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

One or more private IP addresses.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a secondary private IP address for a network interface.

\n ", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP addresses.

\n " + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the private IP address is the primary private IP address.

\n " + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer", + "documentation": "\n\t\t

The number of secondary private IP addresses to assign to a network\n\t\t\t\tinterface. When you specify a number of secondary IP addresses, Amazon EC2\n\t\t\t\tselects these IP addresses within the subnet range.

\n

The number of IP addresses you can assign to a network interface\n\t\t\t\tvaries by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n " + }, + "DryRun": { + "type": "boolean", + "documentation": "\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "NetworkInterface": { + "type": "structure", + "documentation": "\n\t\t

Information about the network interface.

\n ", + "locationName": "networkInterface", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n\t\t

The Availability Zone.

\n ", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

A description.

\n ", + "locationName": "description" + }, + "OwnerId": { + "type": "string", + "documentation": "\n\t\t

The AWS account ID of the owner of the network interface.

\n ", + "locationName": "ownerId" + }, + "RequesterId": { + "type": "string", + "documentation": "\n\t\t

The ID of the entity that launched the instance on your behalf (for example, AWS\n\t\t\t\tManagement Console or Auto Scaling).

\n ", + "locationName": "requesterId" + }, + "RequesterManaged": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the network interface is being managed by AWS.

\n ", + "locationName": "requesterManaged" + }, + "Status": { + "type": "string", + "enum": [ + "available", + "attaching", + "in-use", + "detaching" + ], + "documentation": "\n\t\t

The status of the network interface.

\n ", + "locationName": "status" + }, + "MacAddress": { + "type": "string", + "documentation": "\n\t\t

The MAC address.

\n ", + "locationName": "macAddress" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The IP address of the network interface within the subnet.

\n ", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n\t\t

The private DNS name.

\n ", + "locationName": "privateDnsName" + }, + "SourceDestCheck": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether traffic to or from the instance is validated.

\n ", + "locationName": "sourceDestCheck" + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

Any security groups for the network interface.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "documentation": "\n\t\t

The network interface attachment.

\n ", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface attachment.

\n ", + "locationName": "attachmentId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "documentation": "\n\t\t

The AWS account ID of the owner of the instance.

\n ", + "locationName": "instanceOwnerId" + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The device index of the network interface attachment on the instance.

\n ", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The attachment state.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n\t\t

The timestamp indicating when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the network interface is deleted when the instance is terminated.

\n ", + "locationName": "deleteOnTermination" + } + } + }, + "Association": { + "type": "structure", + "documentation": "\n\t\t

The association information for an Elastic IP associated with the network interface.

\n ", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The address of the Elastic IP address bound to the network interface.

\n ", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n\t\t

The public DNS name.

\n\t", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Elastic IP address owner.

\n ", + "locationName": "ipOwnerId" + }, + "AllocationId": { + "type": "string", + "documentation": "\n\t\t

The allocation ID.

\n ", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "documentation": "\n\t\t

The association ID.

\n ", + "locationName": "associationId" + } + } + }, + "TagSet": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the network interface.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

The private IP addresses associated with the network interface.

\n ", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes the private IP address of a network interface.

\n ", + "locationName": "item", + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP address.

\n ", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n\t\t

The private DNS name.

\n ", + "locationName": "privateDnsName" + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this IP address is the primary private IP address of the network interface.

\n ", + "locationName": "primary" + }, + "Association": { + "type": "structure", + "documentation": "\n\t\t

The association information for an Elastic IP address associated with the network interface.

\n ", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The address of the Elastic IP address bound to the network interface.

\n ", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n\t\t

The public DNS name.

\n\t", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Elastic IP address owner.

\n ", + "locationName": "ipOwnerId" + }, + "AllocationId": { + "type": "string", + "documentation": "\n\t\t

The allocation ID.

\n ", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "documentation": "\n\t\t

The association ID.

\n ", + "locationName": "associationId" + } + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Creates a network interface in the specified subnet.

\n\t\t

For more information about network interfaces, see Elastic Network Interfaces \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example 1\n This example creates a network interface in the specified\n\t\t\t\t\tsubnet with a primary IP address that is automatically selected by Amazon EC2.\n https://ec2.amazonaws.com/?Action=CreateNetworkInterface\n&SubnetId=subnet-b2a249da\n&AUTHPARAMS\n <CreateNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>8dbe591e-5a22-48cb-b948-dd0aadd55adf</requestId>\n <networkInterface>\n <networkInterfaceId>eni-cfca76a6</networkInterfaceId>\n <subnetId>subnet-b2a249da</subnetId>\n <vpcId>vpc-c31dafaa</vpcId>\n <availabilityZone>ap-southeast-1b</availabilityZone>\n <description/>\n <ownerId>251839141158</ownerId>\n <requesterManaged>false</requesterManaged>\n <status>available</status>\n <macAddress>02:74:b0:72:79:61</macAddress>\n <privateIpAddress>10.0.2.157</privateIpAddress>\n <sourceDestCheck>true</sourceDestCheck>\n <groupSet>\n <item>\n <groupId>sg-1a2b3c4d</groupId>\n <groupName>default</groupName>\n </item>\n </groupSet>\n <tagSet/>\n <privateIpAddressesSet>\n <item>\n <privateIpAddress>10.0.2.157</privateIpAddress>\n <primary>true</primary>\n </item>\n </privateIpAddressesSet>\n </networkInterface>\n</CreateNetworkInterfaceResponse>\n \n \n Example 2\n This example creates a network interface in the specified\n\t\t\t\t\tsubnet with a primary IP address of 10.0.2.140 and four secondary private IP\n\t\t\t\t\taddresses that are automatically selected by Amazon EC2.\n https://ec2.amazonaws.com/?Action=CreateNetworkInterface\n&PrivateIpAddresses.0.Primary=true\n&PrivateIpAddresses.0.PrivateIpAddress=10.0.2.140\n&SecondaryPrivateIpAddressCount=4\n&SubnetId=subnet-a61dafcf\n&AUTHPARAMS\n <CreateNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>bd78c839-0895-4fac-a17f-98b559b6b630</requestId>\n <networkInterface>\n <networkInterfaceId>eni-1bcb7772</networkInterfaceId>\n <subnetId>subnet-a61dafcf</subnetId>\n <vpcId>vpc-c31dafaa</vpcId>\n <availabilityZone>ap-southeast-1b</availabilityZone>\n <description/>\n <ownerId>251839141158</ownerId>\n <requesterManaged>false</requesterManaged>\n <status>pending</status>\n <macAddress>02:74:b0:70:7f:1a</macAddress>\n <privateIpAddress>10.0.2.140</privateIpAddress>\n <sourceDestCheck>true</sourceDestCheck>\n <groupSet>\n <item>\n <groupId>sg-1a2b3c4d</groupId>\n <groupName>default</groupName>\n </item>\n </groupSet>\n <tagSet/>\n <privateIpAddressesSet>\n <item>\n <privateIpAddress>10.0.2.140</privateIpAddress>\n <primary>true</primary>\n </item>\n <item>\n <privateIpAddress>10.0.2.172</privateIpAddress>\n <primary>false</primary>\n </item>\n <item>\n <privateIpAddress>10.0.2.169</privateIpAddress>\n <primary>false</primary>\n </item>\n <item>\n <privateIpAddress>10.0.2.170</privateIpAddress>\n <primary>false</primary>\n </item>\n <item>\n <privateIpAddress>10.0.2.171</privateIpAddress>\n <primary>false</primary>\n </item>\n </privateIpAddressesSet>\n </networkInterface>\n</CreateNetworkInterfaceResponse>\n \n \n Example 3\n This example creates a network interface with a primary private IP\n\t\t\t\t\taddress of 10.0.2.130 and two secondary IP addresses of 10.0.2.132 and\n\t\t\t\t\t10.0.2.133.\n https://ec2.amazonaws.com/?Action=CreateNetworkInterface\n&PrivateIpAddresses.0.Primary=true\n&PrivateIpAddresses.0.PrivateIpAddress=10.0.2.130\n&PrivateIpAddresses.1.Primary=false\n&PrivateIpAddresses.1.PrivateIpAddress=10.0.2.132\n&PrivateIpAddresses.2.Primary=false\n&PrivateIpAddresses.2.PrivateIpAddress=10.0.2.133\n&SubnetId=subnet-a61dafcf\n&AUTHPARAMS\n <CreateNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n<requestId>a9565f4c-f928-4113-859b-905886d11658</requestId>\n <networkInterface>\n <networkInterfaceId>eni-41c47828</networkInterfaceId>\n <subnetId>subnet-a61dafcf</subnetId>\n <vpcId>vpc-c31dafaa</vpcId>\n <availabilityZone>ap-southeast-1b</availabilityZone>\n <description/>\n <ownerId>251839141158</ownerId>\n <requesterManaged>false</requesterManaged>\n <status>pending</status>\n <macAddress>02:74:b0:78:bf:ab</macAddress>\n <privateIpAddress>10.0.2.130</privateIpAddress>\n <sourceDestCheck>true</sourceDestCheck>\n <groupSet>\n <item>\n <groupId>sg-188d9f74</groupId>\n <groupName>default</groupName>\n </item>\n </groupSet>\n <tagSet/>\n <privateIpAddressesSet>\n <item>\n <privateIpAddress>10.0.2.130</privateIpAddress>\n <primary>true</primary>\n </item>\n <item>\n <privateIpAddress>10.0.2.133</privateIpAddress>\n <primary>false</primary>\n </item>\n <item>\n <privateIpAddress>10.0.2.132</privateIpAddress>\n <primary>false</primary>\n </item>\n </privateIpAddressesSet>\n </networkInterface>\n</CreateNetworkInterfaceResponse>\n \n \n " + }, + "CreatePlacementGroup": { + "name": "CreatePlacementGroup", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "GroupName", + "Strategy" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

A name for the placement group.

\n

Constraints: Up to 255 ASCII characters

\n " + }, + "Strategy": { + "type": "string", + "enum": [ + "cluster" + ], + "documentation": "\n

The placement strategy.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Creates a placement group that you launch cluster instances into. You must give\n\t\t\t the group a name that's unique within the scope of your account.

\n

For more information about placement groups and cluster instances, see\n\t\t\t\tCluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example creates a placement group named XYZ-cluster.\n https://ec2.amazonaws.com/?Action=CreatePlacementGroup\n&GroupName=XYZ-cluster\n&Strategy=cluster\n&AUTHPARAMS\n <CreatePlacementGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId>\n <return>true</return>\n</CreatePlacementGroupResponse>\n \n \n " + }, + "CreateReservedInstancesListing": { + "name": "CreateReservedInstancesListing", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members": { + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

The ID of the active Reserved Instance.

\n " + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

The number of instances that are a part of a Reserved Instance account to be listed\n\t\t\t\tin the Reserved Instance Marketplace. This number should be less than or equal to the\n\t\t\t\tinstance count associated with the Reserved Instance ID specified in this call.

\n " + }, + "PriceSchedules": { + "type": "list", + "documentation": "\n

A list specifying the price of the Reserved Instance for each month\n\t\t\t\tremaining in the Reserved Instance term.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes the price for a Reserved Instance.

\n ", + "members": { + "Term": { + "type": "long", + "documentation": "\n

The number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.

\n " + }, + "Price": { + "type": "double", + "documentation": "\n

The fixed price for the term.

\n " + }, + "CurrencyCode": { + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\n

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

\n " + } + } + } + }, + "ClientToken": { + "type": "string", + "documentation": "\n

Unique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\tEnsuring Idempotency \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesListings": { + "type": "list", + "documentation": "\n

Information about the Reserved Instances listing.

\n ", + "locationName": "reservedInstancesListingsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance listing.

\n ", + "locationName": "item", + "members": { + "ReservedInstancesListingId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance listing.

\n ", + "locationName": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance.

\n ", + "locationName": "reservedInstancesId" + }, + "CreateDate": { + "type": "timestamp", + "documentation": "\n

The time the listing was created.

\n ", + "locationName": "createDate" + }, + "UpdateDate": { + "type": "timestamp", + "documentation": "\n

The last modified timestamp of the listing.

\n ", + "locationName": "updateDate" + }, + "Status": { + "type": "string", + "enum": [ + "active", + "pending", + "cancelled", + "closed" + ], + "documentation": "\n

The status of the Reserved Instance listing.

\n ", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.

\n ", + "locationName": "statusMessage" + }, + "InstanceCounts": { + "type": "list", + "documentation": "\n

The number of instances in this state.

\n ", + "locationName": "instanceCounts", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance listing state.

\n ", + "locationName": "item", + "members": { + "State": { + "type": "string", + "enum": [ + "available", + "sold", + "cancelled", + "pending" + ], + "documentation": "\n

The states of the listed Reserved Instances.

\n ", + "locationName": "state" + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

he number of listed Reserved Instances in the state specified by the state.

\n ", + "locationName": "instanceCount" + } + } + } + }, + "PriceSchedules": { + "type": "list", + "documentation": "\n

The price of the Reserved Instance listing.

\n ", + "locationName": "priceSchedules", + "member": { + "type": "structure", + "documentation": "\n

Describes the price for a Reserved Instance.

\n ", + "locationName": "item", + "members": { + "Term": { + "type": "long", + "documentation": "\n

The number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.

\n ", + "locationName": "term" + }, + "Price": { + "type": "double", + "documentation": "\n

The fixed price for the term.

\n ", + "locationName": "price" + }, + "CurrencyCode": { + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\n

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

\n ", + "locationName": "currencyCode" + }, + "Active": { + "type": "boolean", + "documentation": "\n

The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.

\n

A specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.

\n ", + "locationName": "active" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "ClientToken": { + "type": "string", + "documentation": "\n

The idempotency token you provided when you created the listing.

\n ", + "locationName": "clientToken" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. \n You can submit one Reserved Instance listing at a time.

\n

For more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example creates a Reserved Instance Marketplace listing from the \n specified Reserved Instance, which has 11 months remaining in its term. \n In this example, we set the upfront price at $2.50, and the price drops\n\t\t\t\t\tover the course of the 11-month term if the instance is still not sold.\n https://ec2.amazonaws.com/?Action=CreateReservedInstancesListing\n&ClientToken=myIdempToken1\n&InstanceCount=1\n&PriceSchedules.0.Price=2.5\n&PriceSchedules.0.Term=11\n&PriceSchedules.1.Price=2.0\n&PriceSchedules.1.Term=8\n&PriceSchedules.2.Price=1.5\n&PriceSchedules.2.Term=5\n&PriceSchedules.3.Price=0.7\n&PriceSchedules.3.Term=3\n&PriceSchedules.4.Price=0.1\n&PriceSchedules.4.Term=1\n&ReservedInstancesId=e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE\n&AUTHPARAMS\n \n a42481af-335a-4e9e-b291-bd18dexample\n \n \n 5ec28771-05ff-4b9b-aa31-9e57dEXAMPLE\n e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE\n 2012-07-17T17:11:09.449Z\n 2012-07-17T17:11:09.468Z\n active\n ACTIVE\n \n \n Available\n 1\n \n \n Sold\n 0\n \n \n Cancelled\n 0\n \n \n Pending\n 0\n \n \n \n \n 11\n 2.5\n USD\n true\n \n \n 10\n 2.5\n USD\n false\n \n \n 9\n 2.5\n USD\n false\n \n \n 8\n 2.0\n USD\n false\n \n \n 7\n 2.0\n USD\n false\n \n \n 6\n 2.0\n USD\n false\n \n \n 5\n 1.5\n USD\n false\n \n \n 4\n 1.5\n USD\n false\n \n \n 3\n 0.7\n USD\n false\n \n \n 2\n 0.7\n USD\n false\n \n \n 1\n 0.1\n USD\n false\n \n \n \n myIdempToken1\n \n \n\n \n \n " + }, + "CreateRoute": { + "name": "CreateRoute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "RouteTableId", + "DestinationCidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table for the route.

\n " + }, + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR address block used for the destination match. Routing\n\t\t\t\tdecisions are based on the most specific match.

\n " + }, + "GatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of an Internet gateway attached to your VPC.

\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n\t\t

The ID of a NAT instance in your VPC. The operation fails if\n\t\t\t\tyou specify an instance ID unless exactly one network interface is\n\t\t\t\tattached.

\n " + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of a network interface.

\n " + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of a VPC peering connection.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Creates a route in a route table within a VPC.

\n

You must specify one of the following targets: Internet gateway, NAT instance, VPC peering connection, or network interface.

\n

When determining how to route traffic, we use the route with the most specific\n\t\t\tmatch. For example, let's say the traffic is destined for 192.0.2.3, and the route\n\t\t\ttable includes the following two routes:

\n\t\t\t\n\t\t

Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.

\n

For more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example creates a route in the route table with the ID rtb-e4ad488d. The\n\t\t\t\t\troute matches all traffic (0.0.0.0/0) and routes it to the Internet gateway with the\n\t\t\t\t\tID igw-eaad4883.\n https://ec2.amazonaws.com/?Action=CreateRoute\n&RouteTableId=rtb-e4ad488d\n&DestinationCidrBlock=0.0.0.0/0\n&GatewayId=igw-eaad4883\n&AUTHPARAMS\n \n \n Example 2\n This example creates a route in the route table with the ID rtb-g8ff4ea2. The\n\t\t\t\t\troute sends all traffic (0.0.0.0/0) to the NAT instance with the ID\n\t\t\t\t\ti-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=CreateRoute\n&RouteTableId=rtb-g8ff4ea2\n&DestinationCidrBlock=0.0.0.0/0\n&InstanceId=i-1a2b3c4d\n&AUTHPARAMS\n \n \n Example 3\n This example command creates a route in route table rtb-g8ff4ea2. The route\n matches traffic for the CIDR block 10.0.0.0/16 and routes it to VPC\n peering connection, pcx-111aaa22. This route enables traffic to be\n directed to the other peered VPC in the VPC peering connection.\n https://ec2.amazonaws.com/?Action=CreateRoute\n&RouteTableId=rtb-g8ff4ea2\n&DestinationCidrBlock=10.0.0.0/16\n&vpcPeeringConnectionId=pcx-111aaa22\n&AUTHPARAMS\n \n \n " + }, + "CreateRouteTable": { + "name": "CreateRouteTable", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "RouteTable": { + "type": "structure", + "documentation": "\n\t\t

Information about the route table.

\n ", + "locationName": "routeTable", + "members": { + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table.

\n ", + "locationName": "routeTableId" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "Routes": { + "type": "list", + "documentation": "\n\t\t

The routes in the route table.

\n ", + "locationName": "routeSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a route in a route table.

\n ", + "locationName": "item", + "members": { + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block used for the destination match.

\n ", + "locationName": "destinationCidrBlock" + }, + "GatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of a gateway attached to your VPC.

\n ", + "locationName": "gatewayId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n\t\t

The ID of a NAT instance in your VPC.

\n ", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "documentation": "\n\t\t

The AWS account ID of the owner of the instance.

\n ", + "locationName": "instanceOwnerId" + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of the VPC peering connection.

\n ", + "locationName": "vpcPeeringConnectionId" + }, + "State": { + "type": "string", + "enum": [ + "active", + "blackhole" + ], + "documentation": "\n\t\t

The state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).

\n ", + "locationName": "state" + }, + "Origin": { + "type": "string", + "enum": [ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ], + "documentation": "\n

Describes how the route was created.

\n \n ", + "locationName": "origin" + } + } + } + }, + "Associations": { + "type": "list", + "documentation": "\n\t\t

The associations between the route table and one or more subnets.

\n ", + "locationName": "associationSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an association between a route table and a subnet.

\n ", + "locationName": "item", + "members": { + "RouteTableAssociationId": { + "type": "string", + "documentation": "\n\t\t

The ID of the association between a route table and a subnet.

\n ", + "locationName": "routeTableAssociationId" + }, + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table.

\n ", + "locationName": "routeTableId" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + }, + "Main": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this is the main route table.

\n ", + "locationName": "main" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the route table.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "PropagatingVgws": { + "type": "list", + "documentation": "\n\t\t

Any virtual private gateway (VGW) propagating routes.

\n ", + "locationName": "propagatingVgwSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a virtual private gateway propagating route.

\n ", + "locationName": "item", + "members": { + "GatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway (VGW).

\n ", + "locationName": "gatewayId" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Creates a route table for the specified VPC. After you create a route table, you can\n\t\t\tadd routes and associate the table with a subnet.

\n

For more information about route tables, see Route Tables in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example creates a route table for the VPC with the ID vpc-11ad4878.\n By default, every route table includes a local route that enables traffic to\n\t\t\t\t\tflow within the VPC. The following response shows that route.\n https://ec2.amazonaws.com/?Action=CreateRouteTable\n&VpcId=vpc-11ad4878\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n rtb-f9ad4890\n vpc-11ad4878\n \n \n 10.0.0.0/22\n local\n active\n \n \n \n \n \n\n \n \n " + }, + "CreateSecurityGroup": { + "name": "CreateSecurityGroup", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "GroupName", + "Description" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n

Constraints: Up to 255 characters in length

\n

Constraints for EC2-Classic: ASCII characters

\n

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

\n " + }, + "Description": { + "type": "string", + "documentation": "\n

A description for the security group. This is informational only.

\n ", + "locationName": "GroupDescription" + }, + "VpcId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The ID of the VPC.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates a security group.

\n

A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n\t\t\t\t

EC2-Classic: You can have up to 500 security groups.

\n\t\t\t\t

EC2-VPC: You can create up to 100 security groups per VPC.

\n\t\t\t\n

When you create a security group, you specify a friendly name of your choice. You\n\t\t\t\tcan have a security group for use in EC2-Classic with the same name as a security group\n\t\t\t\tfor use in a VPC. However, you can't have two security groups for use in EC2-Classic with the\n\t\t\t\tsame name or two security groups for use in a VPC with the same name.

\n

You have a default security group for use in EC2-Classic and a default security group\n\t\t\t\tfor use in your VPC. If you don't specify a security group when you launch an instance, the\n\t\t\t\tinstance is launched into the appropriate default security group. A default security\n\t\t\t\tgroup includes a default rule that grants instances unrestricted network access to\n\t\t\t\teach other.

\n

You can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.

\n \n \n Example for EC2-Classic\n This example creates a security group named websrv for EC2-Classic.\n https://ec2.amazonaws.com/?Action=CreateSecurityGroup\n&GroupName=websrv\n&GroupDescription=Web Servers\n&AUTHPARAMS\n <CreateSecurityGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n <groupId>sg-1a2b3c4d</groupId>\n</CreateSecurityGroupResponse>\n \n \n Example for EC2-VPC\n This example creates a security group named WebServerSG for the specified VPC.\n https://ec2.amazonaws.com/?Action=CreateSecurityGroup\n&GroupName=WebServerSG\n&GroupDescription=Web Servers\n&VpcId=vpc-3325caf2\n&AUTHPARAMS\n <CreateSecurityGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n <groupId>sg-0a42d66a</groupId>\n</CreateSecurityGroupResponse>\n \n \n " + }, + "CreateSnapshot": { + "name": "CreateSnapshot", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS volume.

\n " + }, + "Description": { + "type": "string", + "documentation": "\n

A description for the snapshot.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "locationName": "snapshot", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n ", + "locationName": "snapshotId" + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "completed", + "error" + ], + "documentation": "\n

The snapshot state.

\n ", + "locationName": "status" + }, + "StartTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the snapshot was initiated.

\n ", + "locationName": "startTime" + }, + "Progress": { + "type": "string", + "documentation": "\n

The progress of the snapshot, as a percentage.

\n ", + "locationName": "progress" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the Amazon EBS snapshot owner.

\n ", + "locationName": "ownerId" + }, + "Description": { + "type": "string", + "documentation": "\n

The description for the snapshot.

\n ", + "locationName": "description" + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n ", + "locationName": "volumeSize" + }, + "OwnerAlias": { + "type": "string", + "documentation": "\n

The AWS account alias (for example, amazon, self) or AWS account ID\n that owns the snapshot.

\n ", + "locationName": "ownerAlias" + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the snapshot is encrypted.

\n ", + "locationName": "encrypted" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups,\n to make copies of Amazon EBS volumes, and to save data before shutting down an instance.

\n

When a snapshot is created, any AWS Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You can take a snapshot of an attached volume that is in use. However, snapshots only capture\n data that has been written to your Amazon EBS volume at the time the snapshot command is issued;\n this may exclude any data that has been cached by any applications or the operating system. If\n you can pause any file systems on the volume long enough to take a snapshot, your snapshot\n should be complete. However, if you cannot pause all file writes to the volume, you should\n unmount the volume from within the instance, issue the snapshot command, and then remount the\n volume to ensure a consistent and complete snapshot. You may remount and use your volume while\n the snapshot status is pending.

\n

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance\n before taking the snapshot.

\n

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are\n created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and\n any associated snapshots always remain protected.

\n

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example creates a snapshot of the volume with the ID\n vol-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=CreateSnapshot\n&VolumeId=vol-1a2b3c4d\n&Description=Daily+Backup\n&AUTHPARAMS\n <CreateSnapshotResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <snapshotId>snap-1a2b3c4d</snapshotId>\n <volumeId>vol-1a2b3c4d</volumeId>\n <status>pending</status>\n <startTime>YYYY-MM-DDTHH:MM:SS.000Z</startTime>\n <progress>60%</progress>\n <ownerId>111122223333</ownerId>\n <volumeSize>30</volumeSize>\n <description>Daily Backup</description>\n</CreateSnapshotResponse>\n \n \n " + }, + "CreateSpotDatafeedSubscription": { + "name": "CreateSpotDatafeedSubscription", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Bucket" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Bucket": { + "type": "string", + "documentation": "\n

The Amazon S3 bucket in which to store the Spot Instance datafeed.

\n

Constraints: Must be a valid bucket associated with your AWS account.

\n " + }, + "Prefix": { + "type": "string", + "documentation": "\n

A prefix for the datafeed file names.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "SpotDatafeedSubscription": { + "type": "structure", + "documentation": "\n

The Spot Instance datafeed subscription.

\n ", + "locationName": "spotDatafeedSubscription", + "members": { + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the account.

\n ", + "locationName": "ownerId" + }, + "Bucket": { + "type": "string", + "documentation": "\n

The Amazon S3 bucket where the Spot Instance datafeed is located.

\n ", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "documentation": "\n

The prefix that is prepended to datafeed files.

\n ", + "locationName": "prefix" + }, + "State": { + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "documentation": "\n

The state of the Spot Instance datafeed subscription.

\n ", + "locationName": "state" + }, + "Fault": { + "type": "structure", + "documentation": "\n

The fault codes for the Spot Instance request, if any.

\n ", + "locationName": "fault", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The reason code for the Spot Instance state change.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

The message for the Spot Instance state change.

\n ", + "locationName": "message" + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates a datafeed for Spot Instances, enabling you to view Spot Instance usage logs.\n\t\t\t\tYou can create one data feed per AWS account. For more information, see\n\t\t\t\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example creates a Spot Instance datafeed for the account.\n https://ec2.amazonaws.com/?Action=CreateSpotDatafeedSubscription\n&Bucket=my-s3-bucket\n&AUTHPARAMS\n <CreateSpotDatafeedSubscriptionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <spotDatafeedSubscription>\n <ownerId>123456789012</ownerId>\n <bucket>my-s3-bucket</bucket>\n <prefix>spotdata_</prefix>\n <state>Active</state>\n </spotDatafeedSubscription>\n</CreateSpotDatafeedSubscriptionResponse>\n \n \n " + }, + "CreateSubnet": { + "name": "CreateSubnet", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpcId", + "CidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

\n " + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n\t\t

The Availability Zone for the subnet.

\n\t\t

Default: Amazon EC2 selects one for you (recommended).

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Subnet": { + "type": "structure", + "documentation": "\n\t\t

Information about the subnet.

\n ", + "locationName": "subnet", + "members": { + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available" + ], + "documentation": "\n\t\t

The current state of the subnet.

\n ", + "locationName": "state" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC the subnet is in.

\n ", + "locationName": "vpcId" + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block assigned to the subnet.

\n ", + "locationName": "cidrBlock" + }, + "AvailableIpAddressCount": { + "type": "integer", + "documentation": "\n\t\t

The number of unused IP addresses in the subnet. Note that the IP addresses for any\n\t\t\t\tstopped instances are considered unavailable.

\n ", + "locationName": "availableIpAddressCount" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n\t\t

The Availability Zone of the subnet.

\n ", + "locationName": "availabilityZone" + }, + "DefaultForAz": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this is the default subnet for the Availability Zone.

\n ", + "locationName": "defaultForAz" + }, + "MapPublicIpOnLaunch": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether instances launched in this subnet receive a public IP address.

\n ", + "locationName": "mapPublicIpOnLaunch" + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the subnet.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates a subnet in an existing VPC.

\n

When you create each subnet, you provide the VPC ID and the CIDR block you want\n\t\t\t\tfor the subnet. After you create a subnet, you can't change its CIDR block. The\n\t\t\t\tsubnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only\n\t\t\t\ta single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more\n\t\t\t\tthan one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest\n\t\t\t\tsubnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the\n\t\t\t\tlargest uses a /16 netmask (65,536 IP addresses).

\n \n

AWS reserves both the first four and the last IP address in each subnet's\n CIDR block. They're not available for use.

\n \n\t\t

If you add more than one subnet to a VPC, they're set up in a star topology with a\n\t\t\t\tlogical router in the middle.

\n\t\t

For more information about subnets, see Your VPC and Subnets\n\t\t\t in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example creates a subnet with CIDR block 10.0.1.0/24 in the VPC with the ID\n\t\t\t\t\tvpc-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=CreateSubnet\n&VpcId=vpc-1a2b3c4d\n&CidrBlock=10.0.1.0/24\n&AUTHPARAMS\n <CreateSubnetResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <subnet>\n <subnetId>subnet-9d4a7b6c</subnetId>\n <state>pending</state>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <cidrBlock>10.0.1.0/24</cidrBlock> \n <availableIpAddressCount>251</availableIpAddressCount>\n <availabilityZone>us-east-1a</availabilityZone>\n <tagSet/>\n </subnet>\n</CreateSubnetResponse>\n \n \n " + }, + "CreateTags": { + "name": "CreateTags", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Resources", + "Tags" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Resources": { + "type": "list", + "documentation": "\n

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ResourceId" + } + }, + "Tags": { + "type": "list", + "documentation": "\n

One or more tags. The value parameter is required, but if you don't want the tag to have a value,\n specify the parameter with no value, and we set the value to an empty\n string.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "Tag", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n " + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n " + } + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Adds or overwrites one or more tags for the specified EC2 resource or resources.\n Each resource can have a maximum of 10 tags. Each tag consists of a key and optional\n value. Tag keys must be unique per resource.

\n

For more information about tags, see Tagging\n Your Resources in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request adds (or overwrites) two tags for an AMI and an instance. One\n of the tags is just a key (webserver), with no value (we set the value to an empty\n string). The other tag consists of a key (stack) and value\n (Production).\n https://ec2.amazonaws.com/?Action=CreateTags\n&ResourceId.1=ami-1a2b3c4d\n&ResourceId.2=i-7f4d3a2b\n&Tag.1.Key=webserver\n&Tag.1.Value=\n&Tag.2.Key=stack\n&Tag.2.Value=Production\n&AUTHPARAMS\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n true\n\n \n \n " + }, + "CreateVolume": { + "name": "CreateVolume", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "AvailabilityZone" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Size": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiBs.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10\n GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size, the\n default is the snapshot size.

\n " + }, + "SnapshotId": { + "type": "string", + "documentation": "\n

The snapshot from which to create the volume.

\n " + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to\n list the Availability Zones that are currently available to you.

\n " + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

\n

Default: standard

\n " + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the volume supports. This parameter is not\n used with Magnetic or General Purpose (SSD) volumes, but is required when the volume type is\n io1.

\n " + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Specifies whether the volume should be encrypted.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "locationName": "volume", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "Size": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiBs.

\n ", + "locationName": "size" + }, + "SnapshotId": { + "type": "string", + "documentation": "\n

The snapshot from which the volume was created, if applicable.

\n ", + "locationName": "snapshotId" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone for the volume.

\n ", + "locationName": "availabilityZone" + }, + "State": { + "type": "string", + "enum": [ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ], + "documentation": "\n

The volume state.

\n ", + "locationName": "status" + }, + "CreateTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when volume creation was initiated.

\n ", + "locationName": "createTime" + }, + "Attachments": { + "type": "list", + "documentation": "\n ", + "locationName": "attachmentSet", + "member": { + "type": "structure", + "documentation": "\n

Describes volume attachment details.

\n ", + "locationName": "item", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "Device": { + "type": "string", + "documentation": "\n

The device name.

\n ", + "locationName": "device" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n

The attachment state of the volume.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the volume.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

\n ", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the volume supports.

\n ", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the volume is encrypted.

\n ", + "locationName": "encrypted" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone.\n The volume is created in the specified region.

\n

You can create a new empty volume or restore a volume from an Amazon EBS snapshot.\n Any AWS Marketplace product codes from the snapshot are propagated to the volume.

\n

You can create encrypted volumes with the\n Encrypted parameter. Encrypted volumes may only be attached to instances\n that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also\n automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Creating or\n Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request creates an 80 GiB encrypted volume in the Availability\n Zone us-east-1a.\n https://ec2.amazonaws.com/?Action=CreateVolume\n&Size=80\n&AvailabilityZone=us-east-1a\n&Encrypted=1\n&AUTHPARAMS\n <CreateVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <volumeId>vol-1a2b3c4d</volumeId>\n <size>80</size>\n <snapshotId/>\n <availabilityZone>us-east-1a</availabilityZone>\n <status>creating</status>\n <createTime>YYYY-MM-DDTHH:MM:SS.000Z</createTime>\n <volumeType>standard</volumeType>\n <encrypted>true</encrypted>\n</CreateVolumeResponse>\n \n \n " + }, + "CreateVpc": { + "name": "CreateVpc", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "CidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

\n " + }, + "InstanceTenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n\t\t

The supported tenancy options for instances launched into the VPC.\n\t\t\t\tA value of default means that instances can be launched\n\t\t\t\twith any tenancy; a value of dedicated means all instances\n\t\t\t\tlaunched into the VPC are launched as dedicated tenancy instances regardless of the tenancy\n\t\t\t\tassigned to the instance at launch. Dedicated tenancy instances\n\t\t\t\truns on single-tenant hardware.

\n

Default: default

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Vpc": { + "type": "structure", + "documentation": "\n\t\t

Information about the VPC.

\n ", + "locationName": "vpc", + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available" + ], + "documentation": "\n\t\t

The current state of the VPC.

\n ", + "locationName": "state" + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block for the VPC.

\n ", + "locationName": "cidrBlock" + }, + "DhcpOptionsId": { + "type": "string", + "documentation": "\n\t\t

The ID of the set of DHCP options you've associated with the VPC (or default\n\t\t\t\tif the default options are associated with the VPC).

\n ", + "locationName": "dhcpOptionsId" + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the VPC.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "InstanceTenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n\t\t

The allowed tenancy of instances launched into the VPC.

\n ", + "locationName": "instanceTenancy" + }, + "IsDefault": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the VPC is the default VPC.

\n ", + "locationName": "isDefault" + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Creates a VPC with the specified CIDR block.

\n\t\t

The smallest VPC you can create uses a /28 netmask (16 IP addresses), \n\t\t\t\tand the largest uses a /16 netmask (65,536 IP addresses). \n\t\t\t\tTo help you decide how big to make your VPC, see Your VPC and Subnets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n\t\t

By default, each instance you launch in the VPC has the default DHCP options, which\n\t\t\t includes only a default DNS server that we provide (AmazonProvidedDNS).\n\t\t\t For more information about DHCP options, see DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example creates a VPC with the CIDR block 10.0.0.0/16.\n https://ec2.amazonaws.com/?Action=CreateVpc\n&CidrBlock=10.0.0.0/16\n&AUTHPARAMS\n <CreateVpcResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\t\t\t\t\t\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpc>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <state>pending</state>\n <cidrBlock>10.0.0.0/16</cidrBlock> \n <dhcpOptionsId>dopt-1a2b3c4d2</dhcpOptionsId>\n <instanceTenancy>default</instanceTenancy>\n <tagSet/>\n </vpc>\n</CreateVpcResponse>\n \n \n Example 2\n This example creates a VPC with the dedicated tenancy option.\n https://ec2.amazonaws.com/?Action=CreateVpc\n&CidrBlock=10.32.0.0/16\n&InstanceTenancy=dedicated\n&AUTHPARAMS\n <CreateVpcResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>a9e49797-a74f-4f68-b302-a134a51fd054</requestId>\n <vpc>\n <vpcId>vpc-11a63c78</vpcId>\n <state>pending</state>\n <cidrBlock>10.32.0.0/16</cidrBlock>\n <dhcpOptionsId>dopt-1a2b3c4d2</dhcpOptionsId>\n <instanceTenancy>dedicated</instanceTenancy>\n </vpc>\n</CreateVpcResponse>\n \n \n " + }, + "CreateVpcPeeringConnection": { + "name": "CreateVpcPeeringConnection", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the requester VPC.

\n " + }, + "PeerVpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC with which you are creating the VPC peering connection.

\n " + }, + "PeerOwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the owner of the peer VPC.

\n

Default: Your AWS account ID

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpcPeeringConnection": { + "type": "structure", + "documentation": "\n

Information about the VPC peering connection.

\n ", + "locationName": "vpcPeeringConnection", + "members": { + "AccepterVpcInfo": { + "type": "structure", + "documentation": "\n

The information of the peer VPC.

\n ", + "locationName": "accepterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "documentation": "\n

The CIDR block for the VPC.

\n ", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the VPC owner.

\n ", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC.

\n ", + "locationName": "vpcId" + } + } + }, + "ExpirationTime": { + "type": "timestamp", + "documentation": "\n

The time that an unaccepted VPC peering connection will expire.

\n ", + "locationName": "expirationTime" + }, + "RequesterVpcInfo": { + "type": "structure", + "documentation": "\n

The information of the requester VPC.

\n ", + "locationName": "requesterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "documentation": "\n

The CIDR block for the VPC.

\n ", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the VPC owner.

\n ", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC.

\n ", + "locationName": "vpcId" + } + } + }, + "Status": { + "type": "structure", + "documentation": "\n

The status of the VPC peering connection.

\n ", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The status of the VPC peering connection.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

A message that provides more information about the status, if applicable.

\n ", + "locationName": "message" + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of the VPC peering connection.

\n ", + "locationName": "vpcPeeringConnectionId" + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer\n VPC with which to create the connection. The peer VPC can belong to another AWS\n account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

\n

The owner of the peer VPC must accept the peering request to activate the peering\n connection. The VPC peering connection request expires after 7 days, after which it\n cannot be accepted or rejected.

\n

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks\n results in the VPC peering connection having a status of failed.

\n \n \n Example 1\n This example requests a peering connection between your VPC (vpc-1a2b3c4d),\n and a VPC (vpc-a1b2c3d4) that belongs to AWS account\n 123456789012. \n https://ec2.amazonaws.com/?Action=CreateVpcPeeringConnection\n&VpcId=vpc-1a2b3c4d\n&PeerVpcId=vpc-a1b2c3d4\n&PeerOwnerId=123456789012\n&AUTHPARAMS \n <CreateVpcPeeringConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpcPeeringConnection>\n <vpcPeeringConnectionId>pcx-73a5401a</vpcPeeringConnectionId>\n <requesterVpcInfo>\n <ownerId>777788889999</ownerId>\n <vpcId>vpc-vpc-1a2b3c4d</vpcId>\n <cidrBlock>10.0.0.0/28</cidrBlock>\n </requesterVpcInfo>\n <accepterVpcInfo>\n <ownerId>123456789012</ownerId>\n <vpcId>vpc-a1b2c3d4</vpcId>\n </accepterVpcInfo>\n <status>\n <code>initiating-request</code>\n <message>Initiating Request to 123456789012</message>\n </status>\n <expirationTime>2014-02-18T14:37:25.000Z</expirationTime>\n <tagSet/>\n </vpcPeeringConnection>\n</CreateVpcPeeringConnectionResponse>\n \n \n Example 2\n This example requests a peering connection between your VPCs vpc-1a2b3c4d and vpc-11122233.\n https://ec2.amazonaws.com/?Action=CreateVpcPeeringConnection\n&VpcId=vpc-1a2b3c4d\n&PeerVpcId=vpc-11122233\n&AUTHPARAMS\n \n \n " + }, + "CreateVpnConnection": { + "name": "CreateVpnConnection", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Type": { + "type": "string", + "documentation": "\n\t\t

The type of VPN connection.

\n " + }, + "CustomerGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the customer gateway.

\n " + }, + "VpnGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway.

\n " + }, + "Options": { + "type": "structure", + "documentation": "\n\t\t

Indicates whether the VPN connection requires static routes. If you\n\t\t\t\tare creating a VPN connection for a device that does not support BGP,\n\t\t\t\tyou must specify true.

\n

Default: false

\n ", + "members": { + "StaticRoutesOnly": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.

\n " + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpnConnection": { + "type": "structure", + "documentation": "\n\t\t

Information about the VPN connection.

\n ", + "locationName": "vpnConnection", + "members": { + "VpnConnectionId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPN connection.

\n ", + "locationName": "vpnConnectionId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\t

The current state of the VPN connection.

\n ", + "locationName": "state" + }, + "CustomerGatewayConfiguration": { + "type": "string", + "documentation": "\n\t\t

The configuration information for the VPN connection's customer gateway (in the\n\t\t\t\tnative XML format). This element is always present in the\n\t\t\t\tCreateVpnConnection response; however, it's present in the\n\t\t\t\tDescribeVpnConnections response only if the VPN connection is in\n\t\t\t\tthe pending or available state.

\n ", + "locationName": "customerGatewayConfiguration" + }, + "Type": { + "type": "string", + "enum": [ + "ipsec.1" + ], + "documentation": "\n\t\t

The type of VPN connection.

\n ", + "locationName": "type" + }, + "CustomerGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the customer gateway at your end of the VPN connection.

\n ", + "locationName": "customerGatewayId" + }, + "VpnGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway at the AWS side of the VPN connection.

\n ", + "locationName": "vpnGatewayId" + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the VPN connection.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "VgwTelemetry": { + "type": "list", + "documentation": "\n\t\t

Information about the VPN tunnel.

\n ", + "locationName": "vgwTelemetry", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes telemetry for a VPN tunnel.

\n ", + "locationName": "item", + "members": { + "OutsideIpAddress": { + "type": "string", + "documentation": "\n\t\t

The Internet-routable IP address of the virtual private gateway's outside interface.

\n ", + "locationName": "outsideIpAddress" + }, + "Status": { + "type": "string", + "enum": [ + "UP", + "DOWN" + ], + "documentation": "\n\t\t

The status of the VPN tunnel.

\n ", + "locationName": "status" + }, + "LastStatusChange": { + "type": "timestamp", + "documentation": "\n\t\t

The date and time of the last change in status.

\n ", + "locationName": "lastStatusChange" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n\t\t

If an error occurs, a description of the error.

\n ", + "locationName": "statusMessage" + }, + "AcceptedRouteCount": { + "type": "integer", + "documentation": "\n\t\t

The number of accepted routes.

\n ", + "locationName": "acceptedRouteCount" + } + } + } + }, + "Options": { + "type": "structure", + "documentation": "\n\t\t

The VPN connection options.

\n ", + "locationName": "options", + "members": { + "StaticRoutesOnly": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.

\n ", + "locationName": "staticRoutesOnly" + } + } + }, + "Routes": { + "type": "list", + "documentation": "\n\t\t

The static routes associated with the VPN connection.

\n ", + "locationName": "routes", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a static route for a VPN connection.

\n ", + "locationName": "item", + "members": { + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block associated with the local subnet of the customer data center.

\n ", + "locationName": "destinationCidrBlock" + }, + "Source": { + "type": "string", + "enum": [ + "Static" + ], + "documentation": "\n\t\t

Indicates how the routes were provided.

\n ", + "locationName": "source" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\t

The current state of the static route.

\n ", + "locationName": "state" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Creates a VPN connection between an existing virtual private gateway and a VPN customer\n\t\t\t\tgateway. The only supported connection type is ipsec.1.

\n\t\t

The response includes information that you need to give to your network administrator \n\t\t to configure your customer gateway.

\n \n\t\t\t

We strongly recommend that you use HTTPS when calling this operation\n\t\t\t\t\tbecause the response contains sensitive cryptographic information for\n\t\t\t\t\tconfiguring your customer gateway.

\n\t\t \n\t\t

If you decide to shut down your VPN connection for any reason and later create a new VPN\n\t\t\t\tconnection, you must reconfigure your customer gateway with the new information\n\t\t\t\treturned from this call.

\n\t\t

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example creates a VPN connection between the virtual private gateway with the ID\n\t\t\t\t\tvgw-8db04f81 and the customer gateway with the ID cgw-b4dc3961. The response\n\t\t\t\t\tincludes configuration information for the customer gateway. Because it's a long set of information, we haven't\n\t\t\t\t included the complete response here. To see an example of the configuation information,\n\t\t\t\t see the Amazon Virtual Private Cloud Network Administrator Guide.\n https://ec2.amazonaws.com/?Action=CreateVpnConnection\n&Type=ipsec.1\n&CustomerGatewayId=cgw-b4dc3961\n&VpnGatewayId=vgw-8db04f81\n&AUTHPARAMS\n <CreateVpnConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpnConnection>\n <vpnConnectionId>vpn-44a8938f</vpnConnectionId>\n <state>pending</state>\n <customerGatewayConfiguration>\n ...Customer gateway configuration data in escaped XML format...\n </customerGatewayConfiguration> \n <type>ipsec.1</type>\n <customerGatewayId>cgw-b4dc3961</customerGatewayId>\n <vpnGatewayId>vgw-8db04f81</vpnGatewayId>\n <tagSet/>\n </vpnConnection>\n</CreateVpnConnectionResponse>\n \n \n Example 2\n This example creates a VPN connection with the static routes option between\n\t\t\t\t\tthe virtual private gateway with the ID vgw-8db04f81, and the customer\n\t\t\t\t\tgateway with the ID cgw-b4dc3961, for a device that does not support the Border\n\t\t\t\t\tGateway Protocol (BGP). The response includes configuration information for the\n\t\t\t\t\tVPN connection's customer gateway. Because it's a long set of information, we haven't\n\t\t\t\t\tincluded the complete response here.\n https://ec2.amazonaws.com/?Action=CreateVpnConnection\n&Type=ipsec.1\n&CustomerGatewayId=cgw-b4dc3961\n&VpnGatewayId=vgw-8db04f81\n&Options.StaticRoutesOnly=true\n&AUTHPARAMS\n <CreateVpnConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>5cc7891f-1f3b-4fc4-a626-bdea8f63ff5a</requestId>\n <vpnConnection>\n <vpnConnectionId>vpn-83ad48ea</vpnConnectionId>\n <state>pending</state>\n <customerGatewayConfiguration>\n ...Customer gateway configuration data in escaped XML format...\n </customerGatewayConfiguration>\n <customerGatewayId>cgw-63ae4b0a</customerGatewayId>\n <vpnGatewayId>vgw-4ea04527</vpnGatewayId>\n <options>\n <staticRoutesOnly>true</staticRoutesOnly>\n </options>\n <routes/>\n </vpnConnection>\n</CreateVpnConnectionResponse>\n \n \n " + }, + "CreateVpnConnectionRoute": { + "name": "CreateVpnConnectionRoute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members": { + "VpnConnectionId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPN connection.

\n " + }, + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block associated with the local subnet of the customer network.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Creates a static route associated with a VPN connection between an existing\n\t\t\t\tvirtual private gateway and a VPN customer gateway. The static route allows traffic\n\t\t\t\tto be routed from the virtual private gateway to the VPN customer gateway.

\n\t\t

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example creates a static route to the VPN connection for the VPN\n\t\t\t\t\tconnection with the ID vpn-83ad48ea to the destination CIDR block 11.12.0.0/16. Note that\n\t\t\t\t\twhen using the Query API the \"/\" is denoted as \"%2F\".\n https://ec2.amazonaws.com/?Action=CreateVpnConnectionRoute\n&DestinationCidrBlock=11.12.0.0%2F16\n&VpnConnectionId=vpn-83ad48ea\n&AUTHPARAMS\n <CreateVpnConnectionRouteResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>4f35a1b2-c2c3-4093-b51f-abb9d7311990</requestId>\n <return>true</return>\n</CreateVpnConnectionRouteResponse>\n \n \n " + }, + "CreateVpnGateway": { + "name": "CreateVpnGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Type" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Type": { + "type": "string", + "enum": [ + "ipsec.1" + ], + "documentation": "\n\t\t

The type of VPN connection this virtual private gateway supports.

\n " + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n\t\t

The Availability Zone for the virtual private gateway.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpnGateway": { + "type": "structure", + "documentation": "\n\t\t

Information about the virtual private gateway.

\n ", + "locationName": "vpnGateway", + "members": { + "VpnGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway.

\n ", + "locationName": "vpnGatewayId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\t

The current state of the virtual private gateway.

\n ", + "locationName": "state" + }, + "Type": { + "type": "string", + "enum": [ + "ipsec.1" + ], + "documentation": "\n\t\t

The type of VPN connection the virtual private gateway supports.

\n ", + "locationName": "type" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n\t\t

The Availability Zone where the virtual private gateway was created.

\n ", + "locationName": "availabilityZone" + }, + "VpcAttachments": { + "type": "list", + "documentation": "\n\t\t

Any VPCs attached to the virtual private gateway.

\n ", + "locationName": "attachments", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an attachment between a virtual private gateway and a VPC.

\n ", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The current state of the attachment.

\n ", + "locationName": "state" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the virtual private gateway.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your\n\t\t\t\tVPN connection. You can create a virtual private gateway before creating the VPC itself.

\n\t\t

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example creates a virtual private gateway.\n https://ec2.amazonaws.com/?Action=CreateVpnGateway\n&Type=ipsec.1\n&AUTHPARAMS\n <CreateVpnGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpnGateway>\n <vpnGatewayId>vgw-8db04f81</vpnGatewayId>\n <state>pending</state>\n <type>ipsec.1</type>\n <availabilityZone>us-east-1a</availabilityZone>\n <attachments/>\n <tagSet/>\n </vpnGateway>\n</CreateVpnGatewayResponse>\n \n \n " + }, + "DeleteCustomerGateway": { + "name": "DeleteCustomerGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "CustomerGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "CustomerGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the customer gateway.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified customer gateway. You must delete the VPN connection before you can delete\n\t\t\t\tthe customer gateway.

\n \n \n Example\n This example deletes the specified customer gateway.\n https://ec2.amazonaws.com/?Action=DeleteCustomerGateway\n&CustomerGatewayId=cgw-b4dc3961\n&AUTHPARAMS\n <DeleteCustomerGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</DeleteCustomerGatewayResponse>\n \n \n " + }, + "DeleteDhcpOptions": { + "name": "DeleteDhcpOptions", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "DhcpOptionsId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "DhcpOptionsId": { + "type": "string", + "documentation": "\n\t\t

The ID of the DHCP options set.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options\n\t\t\t\tbefore you can delete it. You can disassociate the set of DHCP options by\n\t\t\t\tassociating either a new set of options or the default set of options with the VPC.

\n \n \n Example\n This example deletes the specified set of DHCP options.\n https://ec2.amazonaws.com/?Action=DeleteDhcpOptions\t\t\t\t\t\t\t \n&DhcpOptionsId=dopt-7a8b9c2d\n&AUTHPARAMS\n <DeleteDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\t\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> \n <return>true</return>\n</DeleteDhcpOptionsResponse>\n \n \n " + }, + "DeleteInternetGateway": { + "name": "DeleteInternetGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InternetGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InternetGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Internet gateway.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified Internet gateway. You must detach the Internet gateway \n\t\t\t\tfrom the VPC before you can delete it.

\n \n \n Example\n This example deletes the specified Internet gateway.\n https://ec2.amazonaws.com/?Action=DeleteInternetGateway\n&InternetGatewayId=igw-eaad4883\n&AUTHPARAMS\n <DeleteInternetGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteInternetGatewayResponse>\n \n \n " + }, + "DeleteKeyPair": { + "name": "DeleteKeyPair", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "KeyName" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Deletes the specified key pair, by removing the public key from Amazon EC2.

\n \n \n Example\n This example request deletes the key pair named my-key-pair.\n https://ec2.amazonaws.com/?Action=DeleteKeyPair\n&KeyName=my-key-pair\n&AUTHPARAMS\n <DeleteKeyPairResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteKeyPairResponse>\n \n \n " + }, + "DeleteNetworkAcl": { + "name": "DeleteNetworkAcl", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkAclId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network ACL.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. \n\t\t\t\tYou can't delete the default network ACL.

\n \n \n Example\n This example deletes the specified network ACL.\n https://ec2.amazonaws.com/?Action=DeleteNetworkAcl\n&NetworkAclId=acl-2cb85d45\n&AUTHPARAMS\n <DeleteNetworkAclResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteNetworkAclResponse>\n \n \n " + }, + "DeleteNetworkAclEntry": { + "name": "DeleteNetworkAclEntry", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network ACL.

\n " + }, + "RuleNumber": { + "type": "integer", + "documentation": "\n\t\t

The rule number of the entry to delete.

\n " + }, + "Egress": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the rule is an egress rule.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

\n \n \n Example\n This example deletes ingress rule number 100 from the specified network ACL.\n https://ec2.amazonaws.com/?Action=DeleteNetworkAclEntry\n&NetworkAclId=acl-2cb85d45\n&RuleNumber=100\n&AUTHPARAMS\n <DeleteNetworkAclEntryResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteNetworkAclEntryResponse>\n \n \n " + }, + "DeleteNetworkInterface": { + "name": "DeleteNetworkInterface", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified network interface. You must detach the network interface\n\t\t\t before you can delete it.

\n \n \n Example\n This example deletes the specified network interface.\n https://ec2.amazonaws.com/?Action=DeleteNetworkInterface\n&NetworkInterfaceId=eni-ffda3197\n&AUTHPARAMS\n <DeleteNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>e1c6d73b-edaa-4e62-9909-6611404e1739</requestId>\n <return>true</return>\n</DeleteNetworkInterfaceResponse>\n \n \n " + }, + "DeletePlacementGroup": { + "name": "DeletePlacementGroup", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "GroupName" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The name of the placement group.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Deletes the specified placement group. You must terminate all instances in the\n\t\t\t\tplacement group before you can delete the placement group. For more information about placement groups and\n\t\t\t\tcluster instances, see Cluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example deletes the placement group named XYZ-cluster.\n https://ec2.amazonaws.com/?Action=DeletePlacementGroup\n&GroupName=XYZ-cluster\n&AUTHPARAMS\n <DeletePlacementGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId>\n <return>true</return>\n</DeletePlacementGroupResponse>\n \n \n " + }, + "DeleteRoute": { + "name": "DeleteRoute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "RouteTableId", + "DestinationCidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table.

\n " + }, + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR range for the route. The value you specify must\n\t\t\t\tmatch the CIDR for the route exactly.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified route from the specified route table.

\n \n \n Example\n This example deletes the route with destination CIDR 172.16.1.0/24 from the\n\t\t\t\t\tspecified route table.\n https://ec2.amazonaws.com/?Action=DeleteRoute\n&RouteTableId=rtb-e4ad488d\n&DestinationCidrBlock=172.16.1.0/24\n&AUTHPARMS\n <DeleteRouteResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteRouteResponse>\n \n \n " + }, + "DeleteRouteTable": { + "name": "DeleteRouteTable", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "RouteTableId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified route table. You must disassociate the route table from any subnets\n\t\t\t\tbefore you can delete it. You can't delete the main route table.

\n \n \n Example\n This example deletes the specified route table.\n https://ec2.amazonaws.com/?Action=DeleteRouteTable\n&RouteTableId=rtb-e4ad488d\n&AUTHPARAMS\n <DeleteRouteTableResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteRouteTableResponse>\n \n \n " + }, + "DeleteSecurityGroup": { + "name": "DeleteSecurityGroup", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

[EC2-Classic, default VPC] The name of the security group.

\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Deletes a security group.

\n

If you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.

\n \n \n Example for EC2-Classic\n This example deletes the specified security group for EC2-Classic.\n https://ec2.amazonaws.com/?Action=DeleteSecurityGroup\n&GroupName=websrv\n&AUTHPARAMS\n <DeleteSecurityGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteSecurityGroupResponse>\n \n \n Example for EC2-VPC\n his example deletes the specified security group for EC2-VPC.\n https://ec2.amazonaws.com/?Action=DeleteSecurityGroup\n&GroupId=sg-1a2b3c4d\n&AUTHPARAMS\n <DeleteSecurityGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteSecurityGroupResponse>\n \n \n " + }, + "DeleteSnapshot": { + "name": "DeleteSnapshot", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SnapshotId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS snapshot.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Deletes the specified snapshot.

\n

When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.

\n

You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.

\n

For more information, see Deleting an\n Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request deletes the snapshot with the ID\n snap-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=DeleteSnapshot\n&SnapshotId.1=snap-1a2b3c4d\n&AUTHPARAMS\n <DeleteSnapshotResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteSnapshotResponse>\n \n \n " + }, + "DeleteSpotDatafeedSubscription": { + "name": "DeleteSpotDatafeedSubscription", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Deletes the datafeed for Spot Instances. For more information, see\n\t\t\t\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request deletes the datafeed for the AWS account.\n https://ec2.amazonaws.com/?Action=DeleteSpotDatafeedSubscription\n&AUTHPARAMS\n <DeleteSpotDatafeedSubscriptionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteSpotDatafeedSubscriptionResponse>\n \n \n " + }, + "DeleteSubnet": { + "name": "DeleteSubnet", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SubnetId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified subnet. You must terminate all running instances in the\n\t\t\t\tsubnet before you can delete the subnet.

\n \n \n Example\n This example deletes the specified subnet.\n https://ec2.amazonaws.com/?Action=DeleteSubnet\n&SubnetId=subnet-9d4a7b6c\n&AUTHPARAMS\n <DeleteSubnetResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\t\t\t\t\t\t\t\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</DeleteSubnetResponse>\n \n \n " + }, + "DeleteTags": { + "name": "DeleteTags", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Resources" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Resources": { + "type": "list", + "documentation": "\n

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ResourceId" + } + }, + "Tags": { + "type": "list", + "documentation": "\n

One or more tags to delete. If you omit the value parameter, we delete the tag regardless\n of its value. If you specify this parameter with an empty string as the\n value, we delete the key only if its value is an empty string.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "Tag", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n " + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n " + } + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Deletes the specified set of tags from the specified set of resources. This call is designed\n to follow a DescribeTags request.

\n

For more information about tags, see Tagging\n Your Resources in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example deletes the tags for the AMI with the ID ami-1a2b3c4d.\n First, get a list of the tags by using the DescribeTags request, then delete\n them.\n https://ec2.amazonaws.com/?Action=DeleteTags\n&ResourceId.1=ami-1a2b3c4d\n&Tag.1.Key=webserver\n&Tag.2.Key=stack\n&AUTHPARAMS\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n true\n\n \n \n Example\n This example deletes the stack and webserver tags for two\n particular instances.\n https://ec2.amazonaws.com/?Action=DeleteTags\n&ResourceId.1=i-5f4e3d2a\n&ResourceId.2=i-5f4e3d2a\n&Tag.1.Key=stack\n&Tag.2.Key=webserver\n&AUTHPARAMS\n \n \n Example\n You can specify a tag key without a corresponding tag value to delete the tag\n regardless of its value. This example request deletes all tags that have a key of\n Purpose, regardless of the tag value.\n https://ec2.amazonaws.com/?Action=DeleteTags\n&ResourceId.1=i-5f4e3d2a\n&Tag.1.Key=Purpose\n&AUTHPARAMS\n \n \n Example\n When you create a tag, you can set the tag value to the empty\n string. Correspondingly, you can delete only tags that have a specific key and whose value is\n the empty string. This example request deletes all tags for the specified instance where the\n key is Purpose and the tag value is the empty string.\n https://ec2.amazonaws.com/?Action=DeleteTags\n&ResourceId.1=i-5f4e3d2a\n&Tag.1.Key=Purpose\n&Tag.2.Value=\n&AUTHPARAMS\n \n \n " + }, + "DeleteVolume": { + "name": "DeleteVolume", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Deletes the specified Amazon EBS volume. The volume must be in the available state (not\n attached to an instance).

\n \n

The volume may remain in the deleting state for several minutes.

\n \n

For more information, see Deleting an Amazon EBS\n Volume in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request deletes the volume with the ID\n vol-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=DeleteVolume\n&VolumeId=vol-1a2b3c4d\n&AUTHPARAMS\n <DeleteVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeleteVolumeResponse>\n \n \n " + }, + "DeleteVpc": { + "name": "DeleteVpc", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified VPC. You must detach or delete all gateways and resources that are\n\t\t\t\tassociated with the VPC before you can delete it. For example, you must terminate all instances\n\t\t\t\trunning in the VPC, delete all security groups associated with the VPC (except the default one), \n\t\t\t\tdelete all route tables associated with the VPC (except the default one), and so on.

\n \n \n Example\n This example deletes the specified VPC.\n https://ec2.amazonaws.com/?Action=DeleteVpc\t\t\t\t\t\t\t \n&VpcId=vpc-1a2b3c4d\n&AUTHPARAMS\n <DeleteVpcResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\t\t\t\t\t\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</DeleteVpcResponse>\n \n \n " + }, + "DeleteVpcPeeringConnection": { + "name": "DeleteVpcPeeringConnection", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpcPeeringConnectionId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of the VPC peering connection.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Return": { + "type": "boolean", + "documentation": "\n

Returns true if the request succeeds; otherwise, it returns an error.

\n ", + "locationName": "return" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the\n peer VPC can delete the VPC peering connection if it's in the active\n state. The owner of the requester VPC can delete a VPC peering connection in the\n pending-acceptance state.

\n \n \n Example\n This example deletes the specified VPC peering connection.\n https://ec2.amazonaws.com/?Action=DeleteVpcPeeringConnection\n &vpcPeeringConnectionId=pcx-1a2b3c4d\n&AUTHPARAMS\n <DeleteVpcPeeringConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</DeleteVpcPeeringConnectionResponse>\n \n \n " + }, + "DeleteVpnConnection": { + "name": "DeleteVpnConnection", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpnConnectionId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpnConnectionId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPN connection.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified VPN connection.

\n\t\t

If you're deleting the VPC and its associated components, we recommend that you\n\t\t\t\tdetach the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n\t\t\t\tconnection.

\n \n \n Example\n This example deletes the specified VPN connection.\n https://ec2.amazonaws.com/?Action=DeleteVpnConnection\n&vpnConnectionId=vpn-44a8938f\n&AUTHPARAMS\n <DeleteVpnConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\t\t\t\t\t\t\t\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</DeleteVpnConnectionResponse>\n \n \n " + }, + "DeleteVpnConnectionRoute": { + "name": "DeleteVpnConnectionRoute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members": { + "VpnConnectionId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPN connection.

\n " + }, + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block associated with the local subnet of the customer network.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified static route associated with a VPN connection between an existing\n\t\t\t\tvirtual private gateway and a VPN customer gateway. The static route allows traffic\n\t\t\t\tto be routed from the virtual private gateway to the VPN customer gateway.

\n \n \n Example\n This example deletes a static route to the destination CIDR block\n\t\t\t\t\t11.12.0.0/16 associated with the VPN connection with the ID\n\t\t\t\t\tvpn-83ad48ea. Note that when using the Query API, the \"/\" is\n\t\t\t\t\tdenoted as \"%2F\".\n https://ec2.amazonaws.com/?Action=DeleteVpnConnectionRoute\n&DestinationCidrBlock=11.12.0.0%2F16\n&VpnConnectionId=vpn-83ad48ea\n&AUTHPARAMS\n <DeleteVpnConnectionRouteResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>4f35a1b2-c2c3-4093-b51f-abb9d7311990</requestId>\n <return>true</return>\n</DeleteVpnConnectionRouteResponse>\n \n \n " + }, + "DeleteVpnGateway": { + "name": "DeleteVpnGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpnGatewayId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpnGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Deletes the specified virtual private gateway. We recommend that before you\n\t\t\t\tdelete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note\n\t\t\t\tthat you don't need to delete the virtual private gateway if you plan to delete and\n\t\t\t\trecreate the VPN connection between your VPC and your network.

\n \n \n Example\n This example deletes the specified virtual private gateway.\n https://ec2.amazonaws.com/?Action=DeleteVpnGateway\n&vpnGatewayId=vgw-8db04f81\n&AUTHPARAMS\n <DeleteVpnGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\t\t\t\t\t\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</DeleteVpnGatewayResponse>\n \n \n " + }, + "DeregisterImage": { + "name": "DeregisterImage", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ImageId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": " \n

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch\n\t\t\t\tnew instances.

\n

This command does not delete the AMI.

\n \n \n Example\n This example request deregisters the specified AMI.\n https://ec2.amazonaws.com/?Action=DeregisterImage\n&ImageId=ami-4fa54026\n&AUTHPARAMS\n <DeregisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeregisterImageResponse>\n \n \n " + }, + "DescribeAccountAttributes": { + "name": "DescribeAccountAttributes", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "AttributeNames": { + "type": "list", + "documentation": "\n

One or more account attribute names.

\n ", + "flattened": true, + "member": { + "type": "string", + "enum": [ + "supported-platforms", + "default-vpc" + ], + "documentation": null, + "locationName": "AttributeName" + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "AccountAttributes": { + "type": "list", + "documentation": "\n

Information about one or more account attributes.

\n ", + "locationName": "accountAttributeSet", + "member": { + "type": "structure", + "documentation": " \n

Describes an account attribute.

\n ", + "locationName": "item", + "members": { + "AttributeName": { + "type": "string", + "documentation": " \n

The name of the account attribute.

\n ", + "locationName": "attributeName" + }, + "AttributeValues": { + "type": "list", + "documentation": " \n

One or more values for the account attribute.

\n ", + "locationName": "attributeValueSet", + "member": { + "type": "structure", + "documentation": " \n

Describes a value of an account attribute.

\n ", + "locationName": "item", + "members": { + "AttributeValue": { + "type": "string", + "documentation": " \n

The value.

\n ", + "locationName": "attributeValue" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": " \n

Describes the specified attribute of your AWS account.

\n \n \n Example\n This example describes the platforms that are supported by your\n\t\t\t\t\tAWS account. The first response is for an account that supports only EC2-VPC.\n\t\t\t\t\tThe second response if for an account that supports both EC2-Classic and EC2-VPC.\n https://ec2.amazonaws.com/?Action=DescribeAccountAttributes\n&AttributeName.1=supported-platforms\n&AUTHPARAMS\n <DescribeAccountAttributesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <accountAttributeSet>\n <item>\n <attributeName>supported-platforms</attributeName>\n <attributeValueSet>\n <item>\n <attributeValue>VPC</attributeValue>    \n </item>\n </attributeValueSet>\n </item>\n </accountAttributeSet>\n</DescribeAccountAttributesResponse>\n <DescribeAccountAttributesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <accountAttributeSet>\n <item>\n <attributeName>supported-platforms</attributeName>\n <attributeValueSet>\n <item>\n <attributeValue>EC2</attributeValue>    \n </item>\n <item>\n <attributeValue>VPC</attributeValue>    \n </item>\n </attributeValueSet>\n </item>\n </accountAttributeSet>\n</DescribeAccountAttributesResponse>\n \n \n Example 2\n This example describes the ID of your default VPC. \n The first response is for an account that supports only EC2-VPC.\n\t\t\t\t The second response if for an account that supports both EC2-Classic and EC2-VPC.\n https://ec2.amazonaws.com/?Action=DescribeAccountAttributes\n&AttributeName.1=default-vpc\n&AUTHPARAMS\n <DescribeAccountAttributesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <accountAttributeSet>\n <item>\n <attributeName>default-vpc</attributeName>\n <attributeValueSet>\n <item>\n <attributeValue>vpc-xxxxxxxx</attributeValue>    \n </item>\n </attributeValueSet>\n </item>\n </accountAttributeSet>\n</DescribeAccountAttributesResponse>\n <DescribeAccountAttributesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <accountAttributeSet>\n <item>\n <attributeName>default-vpc</attributeName>\n <attributeValueSet>\n <item>\n <attributeValue>none</attributeValue>    \n </item>\n </attributeValueSet>\n </item>\n </accountAttributeSet>\n</DescribeAccountAttributesResponse>\n \n \n " + }, + "DescribeAddresses": { + "name": "DescribeAddresses", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "PublicIps": { + "type": "list", + "documentation": "\n

[EC2-Classic] One or more Elastic IP addresses.

\n

Default: Describes all your Elastic IP addresses.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "PublicIp" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "AllocationIds": { + "type": "list", + "documentation": "\n

[EC2-VPC] One or more allocation IDs.

\n

Default: Describes all your Elastic IP addresses.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "AllocationId" + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Addresses": { + "type": "list", + "documentation": "\n

Information about one or more Elastic IP addresses.

\n ", + "locationName": "addressesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an Elastic IP address.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance the address is associated with (if any).

\n ", + "locationName": "instanceId" + }, + "PublicIp": { + "type": "string", + "documentation": "\n

The Elastic IP address.

\n ", + "locationName": "publicIp" + }, + "AllocationId": { + "type": "string", + "documentation": "\n

The ID representing the allocation of the address for use with EC2-VPC.

\n ", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "documentation": "\n

The ID representing the association of the address with an instance in a VPC.

\n ", + "locationName": "associationId" + }, + "Domain": { + "type": "string", + "enum": [ + "vpc", + "standard" + ], + "documentation": "\n

Indicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).

\n ", + "locationName": "domain" + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "NetworkInterfaceOwnerId": { + "type": "string", + "documentation": "\n

The ID of the AWS account that owns the network interface.

\n ", + "locationName": "networkInterfaceOwnerId" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n

The private IP address associated with the Elastic IP address.

\n ", + "locationName": "privateIpAddress" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of your Elastic IP addresses.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example for EC2-Classic\n This example request describes two specific Elastic IP addresses allocated to your account.\n\t\t\t\t\tBoth addresses were created for instances in EC2-Classic, so you must specify them using \n\t\t\t\t\ttheir IP addresses. The address 192.0.2.1 is assigned to instance i-f15ebb98, \n\t\t\t\t\tand 198.51.100.2 isn't assigned to an instance.\n https://ec2.amazonaws.com/?Action=DescribeAddresses\n&PublicIp.1=192.0.2.1\n&PublicIp.2=198.51.100.2\n&AUTHPARAMS\n <DescribeAddressesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <addressesSet> \n <item>\n <publicIp>192.0.2.1</publicIp>\n <domain>standard</domain>\n <instanceId>i-f15ebb98</instanceId>\n </item>\n <item>\n <publicIp>198.51.100.2</publicIp>\n <domain>standard</domain>\n <instanceId/>\n </item> \n </addressesSet> \n</DescribeAddressesResponse>\n \n \n Example 1 for EC2-VPC\n This example request describes a specific Elastic IP address allocated to\n\t\t\t\t\tyour account. This address was created for instances in EC2-VPC, \n\t\t\t\t\tso you must use the allocation ID to specify the address.\n https://ec2.amazonaws.com/?Action=DescribeAddresses\n&AllocationId.1= eipalloc-08229861\n&AUTHPARAMS\n <DescribeAddressesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>f7de5e98-491a-4c19-a92d-908d6EXAMPLE</requestId>\n <addressesSet>\n <item>\n <publicIp>203.0.113.41</publicIp>\n <allocationId>eipalloc-08229861</allocationId>\n <domain>vpc</domain>\n <instanceId>i-64600030</instanceId>\n <associationId>eipassoc-f0229899</associationId>\n <networkInterfaceId>eni-ef229886</networkInterfaceId>\n <networkInterfaceOwnerId>053230519467</networkInterfaceOwnerId>\n <privateIpAddress>10.0.0.228</privateIpAddress>\n </item>\n </addressesSet>\n</DescribeAddressesResponse>\n \n \n Example 2 for EC2-VPC\n This example describes your Elastic IP addresses for EC2-VPC only.\n https://ec2.amazonaws.com/?Action=DescribeAddresses\n&Filter.1.Name=domain\n&Filter.1.Value.1=vpc\n&AUTHPARAMS\n \n \n " + }, + "DescribeAvailabilityZones": { + "name": "DescribeAvailabilityZones", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ZoneNames": { + "type": "list", + "documentation": "\n

The names of one or more Availability Zones.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ZoneName" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "AvailabilityZones": { + "type": "list", + "documentation": "\n

Information about one or more Availability Zones.

\n ", + "locationName": "availabilityZoneInfo", + "member": { + "type": "structure", + "documentation": " \n

Describes an Availability Zone.

\n ", + "locationName": "item", + "members": { + "ZoneName": { + "type": "string", + "documentation": " \n

The name of the Availability Zone.

\n ", + "locationName": "zoneName" + }, + "State": { + "type": "string", + "enum": [ + "available" + ], + "documentation": " \n

The state of the Availability Zone.

\n ", + "locationName": "zoneState" + }, + "RegionName": { + "type": "string", + "documentation": " \n

The name of the region.

\n ", + "locationName": "regionName" + }, + "Messages": { + "type": "list", + "documentation": " \n

Any messages about the Availability Zone.

\n ", + "locationName": "messageSet", + "member": { + "type": "structure", + "documentation": " \n

Describes a message about an Availability Zone.

\n ", + "locationName": "item", + "members": { + "Message": { + "type": "string", + "documentation": " \n

The message about the Availability Zone.

\n ", + "locationName": "message" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": " \n

Describes one or more of the Availability Zones that are available to you. The results\n\t\t\t\tinclude zones only for the region you're currently using. If there is an event\n\t\t\t\timpacting an Availability Zone, you can use this request to view the state and any\n\t\t\t\tprovided message for that Availability Zone.

\n

For more information, see Regions and Availability Zones\n in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example request describes the Availability Zones that are available to you.\n\t\t\t\t\tThe response includes Availability Zones only for the current region.\n https://ec2.amazonaws.com/?Action=DescribeAvailabilityZones\n&AUTHPARAMS\n <DescribeAvailabilityZonesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <availabilityZoneInfo>\n <item>\n <zoneName>us-east-1a</zoneName>\n <zoneState>available</zoneState>\n <regionName>us-east-1</regionName>\n <messageSet/>\n </item>\n <item>\n <zoneName>us-east-1b</zoneName>\n <zoneState>available</zoneState>\n <regionName>us-east-1</regionName>\n <messageSet/>\n </item>\n <item>\n <zoneName>us-east-1c</zoneName>\n <zoneState>available</zoneState>\n <regionName>us-east-1</regionName>\n <messageSet/>\n </item>\n <item>\n <zoneName>us-east-1d</zoneName>\n <zoneState>available</zoneState>\n <regionName>us-east-1</regionName>\n <messageSet/>\n </item>\n </availabilityZoneInfo>\n</DescribeAvailabilityZonesResponse>\n \n \n " + }, + "DescribeBundleTasks": { + "name": "DescribeBundleTasks", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "BundleIds": { + "type": "list", + "documentation": "\n

One or more bundle task IDs.

\n

Default: Describes all your bundle tasks.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "BundleId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "BundleTasks": { + "type": "list", + "documentation": "\n

Information about one or more bundle tasks.

\n ", + "locationName": "bundleInstanceTasksSet", + "member": { + "type": "structure", + "documentation": " \n

Describes a bundle task.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": " \n

The ID of the instance associated with this bundle task.

\n ", + "locationName": "instanceId" + }, + "BundleId": { + "type": "string", + "documentation": " \n

The ID for this bundle task.

\n ", + "locationName": "bundleId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ], + "documentation": " \n

The state of the task.

\n ", + "locationName": "state" + }, + "StartTime": { + "type": "timestamp", + "documentation": " \n

The time this task started.

\n ", + "locationName": "startTime" + }, + "UpdateTime": { + "type": "timestamp", + "documentation": " \n

The time of the most recent update for the task.

\n ", + "locationName": "updateTime" + }, + "Storage": { + "type": "structure", + "documentation": " \n

The Amazon S3 storage locations.

\n ", + "locationName": "storage", + "members": { + "S3": { + "type": "structure", + "documentation": "\n

An Amazon S3 storage location.

\n ", + "members": { + "Bucket": { + "type": "string", + "documentation": "\n

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

\n ", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "documentation": "\n

The beginning of the file name of the AMI.

\n ", + "locationName": "prefix" + }, + "AWSAccessKeyId": { + "type": "string", + "documentation": "\n

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.

\n " + }, + "UploadPolicy": { + "type": "string", + "documentation": "\n

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

\n ", + "locationName": "uploadPolicy" + }, + "UploadPolicySignature": { + "type": "string", + "documentation": "\n

The signature of the Base64 encoded JSON document.

\n ", + "locationName": "uploadPolicySignature" + } + } + } + } + }, + "Progress": { + "type": "string", + "documentation": " \n

The level of task completion, as a percent (for example, 20%).

\n ", + "locationName": "progress" + }, + "BundleTaskError": { + "type": "structure", + "documentation": " \n

If the task fails, a description of the error.

\n ", + "locationName": "error", + "members": { + "Code": { + "type": "string", + "documentation": " \n

The error code.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": " \n

The error message.

\n ", + "locationName": "message" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": " \n

Describes one or more of your bundling tasks.

\n

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

\n \n \n Example 1\n This example describes the status of the specified bundle task.\n https://ec2.amazonaws.com/?Action=DescribeBundleTasks\n&bundleId.1=bun-c1a540a8\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n i-12345678\n bun-c1a540a8\n cancelling\n 2008-10-07T11:41:50.000Z\n 2008-10-07T11:51:50.000Z\n \n \n myawsbucket\n winami\n \n \n 20%\n \n \n\n \n \n Example 2\n This example filters the response to include only bundle tasks whose state is either complete or failed, and in addition are targeted for the Amazon S3 bucket named myawsbucket.\n https://ec2.amazonaws.com/?Action=DescribeBundleTasks\n&Filter.1.Name=s3-bucket\n&Filter.1.Value.1=myawsbucket\n&Filter.2.Name=state\n&Filter.2.Name.1=complete\n&Filter.2.Name.2=failed\n&AUTHPARAMS\n \n \n " + }, + "DescribeConversionTasks": { + "name": "DescribeConversionTasks", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Filters": { + "type": "list", + "documentation": "\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "ConversionTaskIds": { + "type": "list", + "documentation": "\n

One or more conversion task IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ConversionTaskId" + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ConversionTasks": { + "type": "list", + "documentation": "\n ", + "locationName": "conversionTasks", + "member": { + "type": "structure", + "documentation": "\n

Describes a conversion task.

\n ", + "locationName": "item", + "required": [ + "ConversionTaskId", + "State" + ], + "members": { + "ConversionTaskId": { + "type": "string", + "documentation": "\n

The ID of the conversion task.

\n ", + "locationName": "conversionTaskId" + }, + "ExpirationTime": { + "type": "string", + "documentation": "\n

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

\n ", + "locationName": "expirationTime" + }, + "ImportInstance": { + "type": "structure", + "documentation": "\n

If the task is for importing an instance, this contains information about the import instance task.

\n ", + "locationName": "importInstance", + "required": [ + "Volumes" + ], + "members": { + "Volumes": { + "type": "list", + "documentation": "\n ", + "locationName": "volumes", + "member": { + "type": "structure", + "documentation": "\n

Describes an import volume task.

\n ", + "locationName": "item", + "required": [ + "BytesConverted", + "AvailabilityZone", + "Status" + ], + "members": { + "BytesConverted": { + "type": "long", + "documentation": "\n

The number of bytes converted so far.

\n ", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone where the resulting instance will reside.

\n ", + "locationName": "availabilityZone" + }, + "Image": { + "type": "structure", + "documentation": "\n

The image.

\n ", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The disk image format.

\n ", + "locationName": "format" + }, + "Size": { + "type": "long", + "documentation": "\n

The size of the disk image.

\n ", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "documentation": "\n

A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.

\n ", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "documentation": "\n

The checksum computed for the disk image.

\n ", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "documentation": "\n

The volume.

\n ", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "documentation": "\n

The size of the volume.

\n ", + "locationName": "size" + }, + "Id": { + "type": "string", + "documentation": "\n

The volume identifier.

\n ", + "locationName": "id" + } + } + }, + "Status": { + "type": "string", + "documentation": "\n

The status of the import of this particular disk image.

\n ", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The status information or errors related to the disk image.

\n ", + "locationName": "statusMessage" + }, + "Description": { + "type": "string", + "documentation": "\n ", + "locationName": "description" + } + } + } + }, + "InstanceId": { + "type": "string", + "documentation": "\n ", + "locationName": "instanceId" + }, + "Platform": { + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\n

The instance operating system.

\n ", + "locationName": "platform" + }, + "Description": { + "type": "string", + "documentation": "\n ", + "locationName": "description" + } + } + }, + "ImportVolume": { + "type": "structure", + "documentation": "\n

If the task is for importing a volume, this contains information about the import volume task.

\n ", + "locationName": "importVolume", + "required": [ + "BytesConverted", + "AvailabilityZone" + ], + "members": { + "BytesConverted": { + "type": "long", + "documentation": "\n

The number of bytes converted so far.

\n ", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone where the resulting volume will reside.

\n ", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "documentation": "\n

The description you provided when starting the import volume task.

\n ", + "locationName": "description" + }, + "Image": { + "type": "structure", + "documentation": "\n

The image.

\n ", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The disk image format.

\n ", + "locationName": "format" + }, + "Size": { + "type": "long", + "documentation": "\n

The size of the disk image.

\n ", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "documentation": "\n

A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.

\n ", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "documentation": "\n

The checksum computed for the disk image.

\n ", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "documentation": "\n

The volume.

\n ", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "documentation": "\n

The size of the volume.

\n ", + "locationName": "size" + }, + "Id": { + "type": "string", + "documentation": "\n

The volume identifier.

\n ", + "locationName": "id" + } + } + } + } + }, + "State": { + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\n

The state of the conversion task.

\n ", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The status message related to the conversion task.

\n ", + "locationName": "statusMessage" + }, + "Tags": { + "type": "list", + "documentation": "\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of your conversion tasks. For more information, see Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes all your conversion tasks. \n https://ec2.amazonaws.com/?Action=DescribeConversionTasks\n &AUTHPARAMS\n \n \n \n \n import-i-fh95npoc\n 2010-12-22T12:01Z\n \n 1000\n us-east-1a\n \n \n VDMK\n 128696320\n \n https://s3.amazonaws.com/myawsbucket/​a3a5e1b6-590d-43cc-97c1-15c7325d3f41/​Win_2008_Server_Data_Center_SP2_32-bit.​vmdkmanifest.xml?AWSAccessKeyId=​AKIAIOSFODNN7EXAMPLE&​Expires=1294855591&​Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n \n \n \n 8\n vol-34d8a2ff\n \n \n active\n \n \n \n \n\n \n \n " + }, + "DescribeCustomerGateways": { + "name": "DescribeCustomerGateways", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "CustomerGatewayIds": { + "type": "list", + "documentation": "\n\t\t

One or more customer gateway IDs.

\n\t\t

Default: Describes all your customer gateways.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "CustomerGatewayId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "CustomerGateways": { + "type": "list", + "documentation": "\n\t\t

Information about one or more customer gateways.

\n ", + "locationName": "customerGatewaySet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a customer gateway.

\n ", + "locationName": "item", + "members": { + "CustomerGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the customer gateway.

\n ", + "locationName": "customerGatewayId" + }, + "State": { + "type": "string", + "documentation": "\n\t\t

The current state of the customer gateway.

\n ", + "locationName": "state" + }, + "Type": { + "type": "string", + "documentation": "\n\t\t

The type of VPN connection the customer gateway supports.

\n ", + "locationName": "type" + }, + "IpAddress": { + "type": "string", + "documentation": "\n\t\t

The Internet-routable IP address of the customer gateway's outside interface.

\n ", + "locationName": "ipAddress" + }, + "BgpAsn": { + "type": "string", + "documentation": "\n\t\t

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

\n ", + "locationName": "bgpAsn" + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the customer gateway.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your VPN customer gateways.

\n\t\t

For more information about VPN customer gateways, see\n\t\t\t\tAdding a Hardware\n\t\t\t\tVirtual Private Gateway to Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example request describes the specified customer gateway.\n https://ec2.amazonaws.com/?Action=DescribeCustomerGateways\n&CustomerGatewayId.1=cgw-b4dc3961\n&AUTHPARAMS\n <DescribeCustomerGatewaysResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <customerGatewaySet>\n <item>\n <customerGatewayId>cgw-b4dc3961</customerGatewayId>\n <state>available</state>\n <type>ipsec.1</type>\n <ipAddress>12.1.2.3</ipAddress> \n <bgpAsn>65534</bgpasn> \n <tagSet/>\n </item>\n </customerGatewaySet>\n</DescribeCustomerGatewaysResponse>\n \n \n Example 2\n This example request uses filters to describe any customer gateway you\n\t\t\t\t\town whose IP address is 12.1.2.3, and whose state is either pending\n\t\t\t\t\tor available.\n https://ec2.amazonaws.com/?Action=DescribeCustomerGateways\n&Filter.1.Name=ip-address\n&Filter.1.Value.1=12.1.2.3\n&Filter.2.Name=state\n&Filter.2.Value.1=pending\n&Filter.2.Value.2=available\n&AUTHPARAMS\n \n \n " + }, + "DescribeDhcpOptions": { + "name": "DescribeDhcpOptions", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "DhcpOptionsIds": { + "type": "list", + "documentation": "\n\t\t

The IDs of one or more DHCP options sets.

\n\t\t

Default: Describes all your DHCP options sets.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "DhcpOptionsId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "DhcpOptions": { + "type": "list", + "documentation": "\n\t\t

Information about one or more DHCP options sets.

\n ", + "locationName": "dhcpOptionsSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a set of DHCP options.

\n ", + "locationName": "item", + "members": { + "DhcpOptionsId": { + "type": "string", + "documentation": "\n\t\t

The ID of the set of DHCP options.

\n ", + "locationName": "dhcpOptionsId" + }, + "DhcpConfigurations": { + "type": "list", + "documentation": "\n\t\t

One or more DHCP options in the set.

\n ", + "locationName": "dhcpConfigurationSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a DHCP configuration option.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n\t\t

The name of a DHCP option.

\n ", + "locationName": "key" + }, + "Values": { + "type": "list", + "documentation": "\n\t\t

One or more values for the DHCP option.

\n ", + "locationName": "valueSet", + "member": { + "type": "string", + "documentation": null, + "locationName": "item" + } + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the DHCP options set.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your DHCP options sets.

\n\t\t

For more information about DHCP options sets, see DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example describes the specified DHCP options set.\n https://ec2.amazonaws.com/?Action=DescribeDhcpOptions\n&DhcpOptionsId.1=dopt-7a8b9c2d\n&AUTHPARAMS\n <DescribeDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <dhcpOptionsSet>\n <item>\n <dhcpOptionsId>dopt-7a8b9c2d</dhcpOptionsId>\n <dhcpConfigurationSet>\n <item>\n <key>domain-name</key>\n <valueSet>\n <item>\n <value>example.com</value>\n </item>\n </valueSet>\n </item>\n <item>\n <key>domain-name-servers</key>\n <valueSet>\n <item>\n <value>10.2.5.1</value>\n </item>\n </valueSet>\n </item>\n <item>\n <key>domain-name-servers</key>\n <valueSet>\n <item>\n <value>10.2.5.2</value>\n </item>\n </valueSet>\n </item>\n </dhcpConfigurationSet>\n <tagSet/>\n </item>\n </dhcpOptionsSet>\n</DescribeDhcpOptionsResponse>\n \n \n Example 2\n This example uses filters to describe any DHCP options set that\n\t\t\t\t\tincludes a domain-name option whose value includes the string\n\t\t\t\t\texample.\n https://ec2.amazonaws.com/?Action=DescribeDhcpOptions\n&Filter.1.Name=key\n&Filter.1.Value.1=domain-name\n&Filter.2.Name=value\n&Filter.2.Value.1=*example*\n&AUTHPARAMS\n \n \n " + }, + "DescribeExportTasks": { + "name": "DescribeExportTasks", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "ExportTaskIds": { + "type": "list", + "documentation": "\n

One or more export task IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ExportTaskId" + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ExportTasks": { + "type": "list", + "documentation": "\n ", + "locationName": "exportTaskSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an export task.

\n ", + "locationName": "item", + "members": { + "ExportTaskId": { + "type": "string", + "documentation": "\n

The ID of the export task.

\n ", + "locationName": "exportTaskId" + }, + "Description": { + "type": "string", + "documentation": "\n

A description of the resource being exported.

\n ", + "locationName": "description" + }, + "State": { + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\n

The state of the conversion task.

\n ", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The status message related to the export task.

\n ", + "locationName": "statusMessage" + }, + "InstanceExportDetails": { + "type": "structure", + "documentation": "\n

The instance being exported.

\n ", + "locationName": "instanceExport", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the resource being exported.

\n ", + "locationName": "instanceId" + }, + "TargetEnvironment": { + "type": "string", + "enum": [ + "citrix", + "vmware", + "microsoft" + ], + "documentation": "\n

The target virtualization environment.

\n ", + "locationName": "targetEnvironment" + } + } + }, + "ExportToS3Task": { + "type": "structure", + "documentation": "\n ", + "locationName": "exportToS3", + "members": { + "DiskImageFormat": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The format for the exported image.

\n ", + "locationName": "diskImageFormat" + }, + "ContainerFormat": { + "type": "string", + "enum": [ + "ova" + ], + "documentation": "\n

The container format used to combine disk images with metadata (such as OVF). If absent, only\n the disk image is exported.

\n ", + "locationName": "containerFormat" + }, + "S3Bucket": { + "type": "string", + "documentation": "\n

The Amazon S3 bucket for the destination image. The destination bucket must\n exist and grant WRITE and READ_ACL permissions to the AWS account\n vm-import-export@amazon.com.

\n ", + "locationName": "s3Bucket" + }, + "S3Key": { + "type": "string", + "documentation": "\n ", + "locationName": "s3Key" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of your export tasks.

\n \n \n Example\n This example describes a single export task. \n https://ec2.amazonaws.com/?Action=DescribeExportTasks\n &exportTaskId.1=export-i-1234wxyz\n &AUTHPARAMS\n <DescribeExportTasksResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <exportTaskSet>\n <item>\n <exportTaskId>export-i-1234wxyz</exportTaskId>\n <description>Example for docs</description>\n <state>active</state>\n <statusMessage>Running</statusMessage>\n <instanceExport>\n <instanceId>i-12345678</instanceId>\n <targetEnvironment>VMWare</targetEnvironment>\n </instanceExport>\n <exportToS3>\n <diskImageFormat>VMDK</diskImageFormat>\n <containerFormat>OVA</containerFormat>\n <s3Bucket>my-bucket-for-exported-vm</s3Bucket>\n <s3Key>my-exports/ export-i-1234wxyz .ova</s3Key>\n </exportToS3>\n </item>\n </exportTaskSet>\n </ DescribeExportTasksResponse>\n \n \n " + }, + "DescribeImageAttribute": { + "name": "DescribeImageAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ImageId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping" + ], + "documentation": "\n

The AMI attribute.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n

Information about the image attribute.

\n ", + "locationName": "imageAttribute", + "members": { + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n ", + "locationName": "imageId" + }, + "LaunchPermissions": { + "type": "list", + "documentation": "\n

One or more launch permissions.

\n ", + "locationName": "launchPermission", + "member": { + "type": "structure", + "documentation": "\n

Describes a launch permission.

\n ", + "locationName": "item", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The AWS account ID.

\n ", + "locationName": "userId" + }, + "Group": { + "type": "string", + "enum": [ + "all" + ], + "documentation": "\n

The name of the group.

\n ", + "locationName": "group" + } + } + } + }, + "ProductCodes": { + "type": "list", + "documentation": "\n

One or more product codes.

\n ", + "locationName": "productCodes", + "member": { + "type": "structure", + "documentation": "\n

Describes a product code.

\n ", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "documentation": "\n

The product code.

\n ", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\n

The type of product code.

\n ", + "locationName": "type" + } + } + } + }, + "KernelId": { + "type": "structure", + "documentation": "\n

The kernel ID.

\n ", + "locationName": "kernel", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "RamdiskId": { + "type": "structure", + "documentation": "\n

The RAM disk ID.

\n ", + "locationName": "ramdisk", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "Description": { + "type": "structure", + "documentation": "\n

A description for the AMI.

\n ", + "locationName": "description", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "SriovNetSupport": { + "type": "structure", + "documentation": " \n ", + "locationName": "sriovNetSupport", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

One or more block device mapping entries.

\n ", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "item", + "members": { + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n ", + "locationName": "virtualName" + }, + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n ", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "locationName": "ebs", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n ", + "locationName": "snapshotId" + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

\n

Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.

\n ", + "locationName": "volumeSize" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.

\n

Default: standard

\n ", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the\n volume supports.

\n

Constraint: Range is 100 to 4000.

\n

Condition: Required when the volume type is io1; not used with\n standard or gp2 volumes.

\n ", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is encrypted.

\n ", + "locationName": "encrypted" + } + } + }, + "NoDevice": { + "type": "string", + "documentation": "\n

Suppresses the specified device included in the block device mapping of the AMI.

\n ", + "locationName": "noDevice" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": " \n

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

\n \n \n Example 1\n This example lists the launch permissions for the specified AMI.\n https://ec2.amazonaws.com/?Action=DescribeImageAttribute\n&ImageId=ami-61a54008\n&Attribute=launchPermission\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n ami-61a54008\n \n \n all\n \n \n 495219933132\n \n \n\n \n \n Example 2\n This example lists the product codes for the specified AMI.\n https://ec2.amazonaws.com/?Action=DescribeImageAttribute\n&ImageId=ami-2bb65342\n&Attribute=productCodes\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n ami-2bb65342\n \n \n a1b2c3d4e5f6g7h8i9j10k11\n marketplace\n \n \n\n \n \n " + }, + "DescribeImages": { + "name": "DescribeImages", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ImageIds": { + "type": "list", + "documentation": "\n

One or more image IDs.

\n

Default: Describes all images available to you.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ImageId" + } + }, + "Owners": { + "type": "list", + "documentation": "\n

Filters the images by the owner. \n\t\t\t\tSpecify an AWS account ID, amazon (owner is Amazon), \n\t\t\t\taws-marketplace (owner is AWS Marketplace), \n\t\t\t\tself (owner is the sender of the request), or\n\t\t\t\tall (all owners).

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Owner" + } + }, + "ExecutableUsers": { + "type": "list", + "documentation": "\n

Scopes the images by users with explicit launch permissions. \n\t\t\t\tSpecify an AWS account ID, self (the sender of the request),\n\t\t\t\tor all (public AMIs).

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ExecutableBy" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Images": { + "type": "list", + "documentation": "\n

Information about one or more images.

\n ", + "locationName": "imagesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an image.

\n ", + "locationName": "item", + "members": { + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n ", + "locationName": "imageId" + }, + "ImageLocation": { + "type": "string", + "documentation": "\n

The location of the AMI.

\n ", + "locationName": "imageLocation" + }, + "State": { + "type": "string", + "enum": [ + "available", + "deregistered" + ], + "documentation": "\n

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

\n ", + "locationName": "imageState" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the image owner.

\n ", + "locationName": "imageOwnerId" + }, + "Public": { + "type": "boolean", + "documentation": "\n

Indicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.

\n ", + "locationName": "isPublic" + }, + "ProductCodes": { + "type": "list", + "documentation": "\n

Any product codes associated with the AMI.

\n ", + "locationName": "productCodes", + "member": { + "type": "structure", + "documentation": "\n

Describes a product code.

\n ", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "documentation": "\n

The product code.

\n ", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\n

The type of product code.

\n ", + "locationName": "type" + } + } + } + }, + "Architecture": { + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\n

The architecture of the image.

\n ", + "locationName": "architecture" + }, + "ImageType": { + "type": "string", + "enum": [ + "machine", + "kernel", + "ramdisk" + ], + "documentation": "\n

The type of image.

\n ", + "locationName": "imageType" + }, + "KernelId": { + "type": "string", + "documentation": "\n

The kernel associated with the image, if any. Only applicable for machine images.

\n ", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "documentation": "\n

The RAM disk associated with the image, if any. Only applicable for machine images.

\n ", + "locationName": "ramdiskId" + }, + "Platform": { + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\n

The value is Windows for Windows AMIs; otherwise blank.

\n ", + "locationName": "platform" + }, + "SriovNetSupport": { + "type": "string", + "documentation": "\n

Specifies whether enhanced networking is enabled.

\n ", + "locationName": "sriovNetSupport" + }, + "StateReason": { + "type": "structure", + "documentation": "\n

The reason for the state change.

\n ", + "locationName": "stateReason", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The reason code for the state change.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

The message for the state change.

\n \n ", + "locationName": "message" + } + } + }, + "ImageOwnerAlias": { + "type": "string", + "documentation": "\n

The AWS account alias (for example, amazon, self) or\n the AWS account ID of the AMI owner.

\n ", + "locationName": "imageOwnerAlias" + }, + "Name": { + "type": "string", + "documentation": "\n

The name of the AMI that was provided during image creation.

\n ", + "locationName": "name" + }, + "Description": { + "type": "string", + "documentation": "\n

The description of the AMI that was provided during image creation.

\n ", + "locationName": "description" + }, + "RootDeviceType": { + "type": "string", + "enum": [ + "ebs", + "instance-store" + ], + "documentation": "\n

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an\n\t\t\t\tinstance store volume.

\n ", + "locationName": "rootDeviceType" + }, + "RootDeviceName": { + "type": "string", + "documentation": "\n

The device name of the root device (for example, /dev/sda1 or xvda).

\n ", + "locationName": "rootDeviceName" + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

Any block device mapping entries.

\n ", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "item", + "members": { + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n ", + "locationName": "virtualName" + }, + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n ", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "locationName": "ebs", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n ", + "locationName": "snapshotId" + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

\n

Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.

\n ", + "locationName": "volumeSize" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.

\n

Default: standard

\n ", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the\n volume supports.

\n

Constraint: Range is 100 to 4000.

\n

Condition: Required when the volume type is io1; not used with\n standard or gp2 volumes.

\n ", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is encrypted.

\n ", + "locationName": "encrypted" + } + } + }, + "NoDevice": { + "type": "string", + "documentation": "\n

Suppresses the specified device included in the block device mapping of the AMI.

\n ", + "locationName": "noDevice" + } + } + } + }, + "VirtualizationType": { + "type": "string", + "enum": [ + "hvm", + "paravirtual" + ], + "documentation": "\n

The type of virtualization of the AMI.

\n ", + "locationName": "virtualizationType" + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the image.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "Hypervisor": { + "type": "string", + "enum": [ + "ovm", + "xen" + ], + "documentation": "\n

The hypervisor type of the image.

\n ", + "locationName": "hypervisor" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": " \n

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to\n\t\t\t\tyou include public images, private images that you own, and private images owned by\n\t\t\t\tother AWS accounts but for which you have explicit launch permissions.

\n

Deregistered images are included in the returned results for an unspecified interval after deregistration.

\n \n \n Example 1\n This example describes the specified AMI.\n https://ec2.amazonaws.com/?Action=DescribeImages\n&ImageId.1=ami-be3adfd7\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n ami-1a2b3c4d\n amazon/getting-started\n available\n 123456789012\n true\n i386\n machine\n aki-1a2b3c4d\n ari-1a2b3c4d\n amazon\n getting-started\n Image Description\n ebs\n /dev/sda\n \n \n /dev/sda1\n \n snap-1a2b3c4d\n 15\n false\n standard\n \n \n \n paravirtual\n \n xen\n \n \n\n \n \n Example 2\n This example filters the response to include only public Windows images with an x86_64 architecture.\n https://ec2.amazonaws.com/?Action=DescribeImages\n&Filter.1.Name=is-public\n&Filter.1.Value.1=true\n&Filter.2.Name=architecture\n&Filter.2.Value.1=x86_64\n&Filter.3.Name=platform\n&Filter.3.Value.1=windows\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n ami-1a2b3c4d\n ec2-public-windows-images/Server2003r2-x86_64-Win-v1.07.manifest.xml\n available\n 123456789012\n true\n x86_64\n machine\n windows\n amazon\n instance-store\n \n hvm\n \n xen\n \n ...\n \n\n \n \n Example 3\n This example returns the results to display images where the owner is\n\t\t\t\t\t\taws-marketplace.\n https://ec2.amazonaws.com/?Action=DescribeImages\n&Owner.0=aws-marketplace\n&AUTHPARAMS\n \n 4a4a27a2-2e7c-475d-b35b-ca822EXAMPLE\n \n \n ami-1a2b3c4d\n aws-marketplace/example-marketplace-amzn-ami.1\n available\n 123456789012\n true\n \n \n a1b2c3d4e5f6g7h8i9j10k11\n marketplace\n \n \n i386\n machine\n aki-1a2b3c4d\n aws-marketplace\n example-marketplace-amzn-ami.1\n Amazon Linux AMI i386 EBS\n ebs\n /dev/sda1\n \n \n /dev/sda1\n \n snap-1a2b3c4d\n 8\n true\n \n \n \n paravirtual\n xen\n \n ...\n \n\n \n \n " + }, + "DescribeInstanceAttribute": { + "name": "DescribeInstanceAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ], + "documentation": "\n

The instance attribute.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "InstanceType": { + "type": "structure", + "documentation": "\n

The instance type.

\n ", + "locationName": "instanceType", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "KernelId": { + "type": "structure", + "documentation": "\n

The kernel ID.

\n ", + "locationName": "kernel", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "RamdiskId": { + "type": "structure", + "documentation": "\n

The RAM disk ID.

\n ", + "locationName": "ramdisk", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "UserData": { + "type": "structure", + "documentation": "\n

The Base64-encoded MIME user data.

\n ", + "locationName": "userData", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "DisableApiTermination": { + "type": "structure", + "documentation": "\n

If the value is true, you can't terminate the instance through the Amazon EC2\n\t\t\t\tconsole, CLI, or API; otherwise, you can.

\n ", + "locationName": "disableApiTermination", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "InstanceInitiatedShutdownBehavior": { + "type": "structure", + "documentation": "\n

Indicates whether an instance stops or terminates when you initiate\n\t\t\t\tshutdown from the instance (using the operating system command for system shutdown).

\n ", + "locationName": "instanceInitiatedShutdownBehavior", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "RootDeviceName": { + "type": "structure", + "documentation": "\n

The name of the root device (for example, /dev/sda1).

\n ", + "locationName": "rootDeviceName", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

The block device mapping of the instance.

\n ", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "item", + "members": { + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n ", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "locationName": "ebs", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS volume.

\n ", + "locationName": "volumeId" + }, + "Status": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n

The attachment state.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + } + } + } + } + } + }, + "ProductCodes": { + "type": "list", + "documentation": "\n

A list of product codes.

\n ", + "locationName": "productCodes", + "member": { + "type": "structure", + "documentation": "\n

Describes a product code.

\n ", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "documentation": "\n

The product code.

\n ", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\n

The type of product code.

\n ", + "locationName": "type" + } + } + } + }, + "EbsOptimized": { + "type": "structure", + "documentation": "\n

Indicates whether the instance is optimized for EBS I/O.

\n ", + "locationName": "ebsOptimized", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "SriovNetSupport": { + "type": "structure", + "documentation": " \n ", + "locationName": "sriovNetSupport", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "SourceDestCheck": { + "type": "structure", + "documentation": "\n

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled.\n This value must be false for a NAT instance to perform NAT.

\n ", + "locationName": "sourceDestCheck", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n ", + "locationName": "value" + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the specified attribute of the specified instance. You can specify only one\n\t\t\t\tattribute at a time.

\n \n \n Example 1\n This example lists the instance type of the specified instance.\n https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute\n&InstanceId=i-10a64379\n&Attribute=instanceType\n&AUTHPARAMS\n <DescribeInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instanceId>i-10a64379</instanceId>\n <instanceType>\n <value>t1.micro</value>\n </instanceType>\n</DescribeInstanceAttributeResponse>\n \n \n Example 2\n This example lists the current value of the InstanceInitiatedShutdownBehavior attribute for the specified instance.\n https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute\n&InstanceId=i-10a64379\n&Attribute=instanceInitiatedShutdownBehavior\n&AUTHPARAMS\n <DescribeInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instanceId>i-10a64379</instanceId>\n <instanceInitiatedShutdownBehavior>\n <value>stop</value>\n </instanceInitiatedShutdownBehavior>\n</DescribeInstanceAttributeResponse>\n \n \n Example 3\n This example lists the current value of the DisableApiTermination attribute for the specified instance.\n https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute\n&InstanceId=i-10a64379\n&Attribute=disableApiTermination\n&AUTHPARAMS\n <DescribeInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instanceId>i-10a64379</instanceId>\n <disableApiTermination>\n <value>false</value>\n </disableApiTermination>\n</DescribeInstanceAttributeResponse>\n \n \n " + }, + "DescribeInstanceStatus": { + "name": "DescribeInstanceStatus", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceIds": { + "type": "list", + "documentation": "\n

One or more instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The next paginated set of results to return.

\n " + }, + "MaxResults": { + "type": "integer", + "documentation": "\n

The maximum number of paginated instance items per response.

\n

Default: 1000

\n " + }, + "IncludeAllInstances": { + "type": "boolean", + "documentation": "\n

When true, includes the health status for all instances.\n\t\t\t\tWhen false, includes the health status for running instances only.

\n\t\t

Default: false

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "InstanceStatuses": { + "type": "list", + "documentation": "\n

One or more instance status descriptions.

\n ", + "locationName": "instanceStatusSet", + "member": { + "type": "structure", + "documentation": "\n

Describes the status of an instance.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone of the instance.

\n ", + "locationName": "availabilityZone" + }, + "Events": { + "type": "list", + "documentation": "\n

Extra information regarding events associated with the instance.

\n ", + "locationName": "eventsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an instance event.

\n ", + "locationName": "item", + "members": { + "Code": { + "type": "string", + "enum": [ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ], + "documentation": "\n

The associated code of the event.

\n ", + "locationName": "code" + }, + "Description": { + "type": "string", + "documentation": "\n

A description of the event.

\n ", + "locationName": "description" + }, + "NotBefore": { + "type": "timestamp", + "documentation": "\n

The earliest scheduled start time for the event.

\n ", + "locationName": "notBefore" + }, + "NotAfter": { + "type": "timestamp", + "documentation": "\n

The latest scheduled end time for the event.

\n ", + "locationName": "notAfter" + } + } + } + }, + "InstanceState": { + "type": "structure", + "documentation": "\n

The intended state of the instance.\n\t\t\t\tDescribeInstanceStatus requires that an\n\t\t\t\tinstance be in the running state.

\n ", + "locationName": "instanceState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + }, + "SystemStatus": { + "type": "structure", + "documentation": "\n

Reports impaired functionality that stems from issues related to the systems that\n\t\t\t\tsupport an instance, such as hardware failures and network connectivity problems.

\n ", + "locationName": "systemStatus", + "members": { + "Status": { + "type": "string", + "enum": [ + "ok", + "impaired", + "insufficient-data", + "not-applicable" + ], + "documentation": "\n

The status.

\n ", + "locationName": "status" + }, + "Details": { + "type": "list", + "documentation": "\n

The system instance health or application instance health.

\n ", + "locationName": "details", + "member": { + "type": "structure", + "documentation": "\n

Describes the instance status.

\n ", + "locationName": "item", + "members": { + "Name": { + "type": "string", + "enum": [ + "reachability" + ], + "documentation": "\n

The type of instance status.

\n ", + "locationName": "name" + }, + "Status": { + "type": "string", + "enum": [ + "passed", + "failed", + "insufficient-data" + ], + "documentation": "\n

The status.

\n ", + "locationName": "status" + }, + "ImpairedSince": { + "type": "timestamp", + "documentation": "\n

The time when a status check failed. For an instance that was launched and\n\t\t\t\timpaired, this is the time when the instance was launched.

\n ", + "locationName": "impairedSince" + } + } + } + } + } + }, + "InstanceStatus": { + "type": "structure", + "documentation": "\n

Reports impaired functionality that stems from issues internal to the instance,\n\t\t\t\tsuch as impaired reachability.

\n ", + "locationName": "instanceStatus", + "members": { + "Status": { + "type": "string", + "enum": [ + "ok", + "impaired", + "insufficient-data", + "not-applicable" + ], + "documentation": "\n

The status.

\n ", + "locationName": "status" + }, + "Details": { + "type": "list", + "documentation": "\n

The system instance health or application instance health.

\n ", + "locationName": "details", + "member": { + "type": "structure", + "documentation": "\n

Describes the instance status.

\n ", + "locationName": "item", + "members": { + "Name": { + "type": "string", + "enum": [ + "reachability" + ], + "documentation": "\n

The type of instance status.

\n ", + "locationName": "name" + }, + "Status": { + "type": "string", + "enum": [ + "passed", + "failed", + "insufficient-data" + ], + "documentation": "\n

The status.

\n ", + "locationName": "status" + }, + "ImpairedSince": { + "type": "timestamp", + "documentation": "\n

The time when a status check failed. For an instance that was launched and\n\t\t\t\timpaired, this is the time when the instance was launched.

\n ", + "locationName": "impairedSince" + } + } + } + } + } + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The next paginated set of results to return.

\n ", + "locationName": "nextToken" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the status of one or more instances, including any scheduled events.

\n\t\t\t

Instance status has two main components:

\n\t\t\t\n

Instance status provides information about four types of scheduled events for an\n instance that may require your attention:

\n\t\t\t\n\n\t\t\t

When your instance is retired, it will either be terminated (if its root device type is the\n\t\t\t\tinstance-store) or stopped (if its root device type is an EBS volume). Instances\n\t\t\t\tstopped due to retirement will not be restarted, but you can do so manually. You can\n\t\t\t\talso avoid retirement of EBS-backed instances by manually restarting your instance\n\t\t\t\twhen its event code is instance-retirement. This ensures that your\n\t\t\t\tinstance is started on a different underlying host.

\n

For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example 1\n This example returns instance status descriptions for all instances.\n https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&AUTHPARAMS\n \n \n Example 2\n This example returns instance status descriptions for the specified instances.\n https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&InstanceId.0=i-1a2b3c4d\n&InstanceId.1=i-2a2b3c4d\n&AUTHPARAMS\n \n \n Example 3\n This example returns instance status descriptions for all instances specified\n\t\t\t\t\tby supported DescribeInstanceStatus filters.\n https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&Filter.0.Name=system-status.reachability\n&Filter.0.Value.failed\n&AUTHPARAMS\n \n 3be1508e-c444-4fef-89cc-0b1223c4f02fEXAMPLE\n \n \n i-1a2b3c4d\n us-east-1d\n \n 16\n running\n \n \n impaired\n
\n \n reachability\n failed\n YYYY-MM-DDTHH:MM:SS.000Z\n \n
\n \n \n impaired\n
\n \n reachability\n failed\n YYYY-MM-DDTHH:MM:SS.000Z\n \n
\n \n \n \n instance-retirement\n The instance is running on degraded hardware\n YYYY-MM-DDTHH:MM:SS+0000\n YYYY-MM-DDTHH:MM:SS+0000\n \n \n \n \n i-2a2b3c4d\n us-east-1d\n \n 16\n running\n \n \n ok\n
\n \n reachability\n passed\n \n
\n \n \n ok\n
\n \n reachability\n passed\n \n
\n \n \n \n instance-reboot\n The instance is scheduled for a reboot\n YYYY-MM-DDTHH:MM:SS+0000\n YYYY-MM-DDTHH:MM:SS+0000\n \n \n \n \n i-3a2b3c4d\n us-east-1d\n \n 16\n running\n \n \n ok\n
\n \n reachability\n passed\n \n
\n \n \n ok\n
\n \n reachability\n passed\n \n
\n \n \n \n i-4a2b3c4d\n us-east-1d\n \n 16\n running\n \n \n ok\n
\n \n reachability\n passed\n \n
\n \n \n insufficient-data\n
\n \n reachability\n insufficient-data\n \n
\n \n \n \n\n \n \n\t " + }, + "DescribeInstances": { + "name": "DescribeInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceIds": { + "type": "list", + "documentation": "\n

One or more instance IDs.

\n

Default: Describes all your instances.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The token for the next set of items to return. (You received this token from a prior call.)

\n " + }, + "MaxResults": { + "type": "integer", + "documentation": "\n

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Reservations": { + "type": "list", + "documentation": "\n

One or more reservations.

\n ", + "locationName": "reservationSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a reservation.

\n ", + "locationName": "item", + "members": { + "ReservationId": { + "type": "string", + "documentation": "\n

The ID of the reservation.

\n ", + "locationName": "reservationId" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The ID of the AWS account that owns the reservation.

\n ", + "locationName": "ownerId" + }, + "RequesterId": { + "type": "string", + "documentation": "\n

The ID of the requester that launched the instances on your behalf (for example,\n\t\t\t\tAWS Management Console or Auto Scaling).

\n ", + "locationName": "requesterId" + }, + "Groups": { + "type": "list", + "documentation": "\n

One or more security groups.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "Instances": { + "type": "list", + "documentation": "\n

One or more instances.

\n ", + "locationName": "instancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an instance.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI used to launch the instance.

\n ", + "locationName": "imageId" + }, + "State": { + "type": "structure", + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "instanceState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n

The private DNS name assigned to the instance. This DNS name can only be used\n\t\t\t\tinside the Amazon EC2 network. This name is not available until the instance enters\n\t\t\t\tthe running state.

\n ", + "locationName": "privateDnsName" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n

The public DNS name assigned to the instance.\n\t\t\t\tThis name is not available until the instance enters the running state.

\n ", + "locationName": "dnsName" + }, + "StateTransitionReason": { + "type": "string", + "documentation": "\n

The reason for the most recent state transition. This might be an empty string.

\n ", + "locationName": "reason" + }, + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair, if this instance was launched with an associated key pair.

\n ", + "locationName": "keyName" + }, + "AmiLaunchIndex": { + "type": "integer", + "documentation": "\n

The AMI launch index, which can be used to find this instance in the launch group.

\n ", + "locationName": "amiLaunchIndex" + }, + "ProductCodes": { + "type": "list", + "documentation": "\n

The product codes attached to this instance.

\n ", + "locationName": "productCodes", + "member": { + "type": "structure", + "documentation": "\n

Describes a product code.

\n ", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "documentation": "\n

The product code.

\n ", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\n

The type of product code.

\n ", + "locationName": "type" + } + } + } + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type.

\n ", + "locationName": "instanceType" + }, + "LaunchTime": { + "type": "timestamp", + "documentation": "\n

The time the instance was launched.

\n ", + "locationName": "launchTime" + }, + "Placement": { + "type": "structure", + "documentation": "\n

The location where the instance launched.

\n ", + "locationName": "placement", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone of the instance.

\n ", + "locationName": "availabilityZone" + }, + "GroupName": { + "type": "string", + "documentation": "\n

The name of the placement group the instance is in (for cluster compute instances).

\n ", + "locationName": "groupName" + }, + "Tenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n

The tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.

\n ", + "locationName": "tenancy" + } + } + }, + "KernelId": { + "type": "string", + "documentation": "\n

The kernel associated with this instance.

\n ", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "documentation": "\n

The RAM disk associated with this instance.

\n ", + "locationName": "ramdiskId" + }, + "Platform": { + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\n

The value is Windows for Windows instances; otherwise blank.

\n ", + "locationName": "platform" + }, + "Monitoring": { + "type": "structure", + "documentation": "\n

The monitoring information for the instance.

\n ", + "locationName": "monitoring", + "members": { + "State": { + "type": "string", + "enum": [ + "disabled", + "enabled", + "pending" + ], + "documentation": "\n

Indicates whether monitoring is enabled for the instance.

\n ", + "locationName": "state" + } + } + }, + "SubnetId": { + "type": "string", + "documentation": "\n

The ID of the subnet in which the instance is running.

\n ", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC in which the instance is running.

\n ", + "locationName": "vpcId" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n

The private IP address assigned to the instance.

\n ", + "locationName": "privateIpAddress" + }, + "PublicIpAddress": { + "type": "string", + "documentation": "\n

The public IP address assigned to the instance.

\n ", + "locationName": "ipAddress" + }, + "StateReason": { + "type": "structure", + "documentation": "\n

The reason for the most recent state transition.

\n ", + "locationName": "stateReason", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The reason code for the state change.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

The message for the state change.

\n \n ", + "locationName": "message" + } + } + }, + "Architecture": { + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\n

The architecture of the image.

\n ", + "locationName": "architecture" + }, + "RootDeviceType": { + "type": "string", + "enum": [ + "ebs", + "instance-store" + ], + "documentation": "\n

The root device type used by the AMI. The AMI can use an Amazon EBS volume\n or an instance store volume.

\n ", + "locationName": "rootDeviceType" + }, + "RootDeviceName": { + "type": "string", + "documentation": "\n

The root device name (for example, /dev/sda1).

\n ", + "locationName": "rootDeviceName" + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

Any block device mapping entries for the instance.

\n ", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "item", + "members": { + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n ", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "locationName": "ebs", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS volume.

\n ", + "locationName": "volumeId" + }, + "Status": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n

The attachment state.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + } + } + } + } + } + }, + "VirtualizationType": { + "type": "string", + "enum": [ + "hvm", + "paravirtual" + ], + "documentation": "\n

The virtualization type of the instance.

\n ", + "locationName": "virtualizationType" + }, + "InstanceLifecycle": { + "type": "string", + "enum": [ + "spot" + ], + "documentation": "\n

Indicates whether this is a Spot Instance.

\n ", + "locationName": "instanceLifecycle" + }, + "SpotInstanceRequestId": { + "type": "string", + "documentation": "\n

The ID of the Spot Instance request.

\n ", + "locationName": "spotInstanceRequestId" + }, + "ClientToken": { + "type": "string", + "documentation": "\n

The idempotency token you provided when you launched the instance.

\n ", + "locationName": "clientToken" + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the instance.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "SecurityGroups": { + "type": "list", + "documentation": "\n

One or more security groups for the instance.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "SourceDestCheck": { + "type": "boolean", + "documentation": "\n

Specifies whether to enable an instance launched in a VPC to\n\t\t\t\tperform NAT. This controls whether source/destination checking\n\t\t\t\tis enabled on the instance. A value of true means\n\t\t\t\tchecking is enabled, and false means checking is\n\t\t\t\tdisabled. The value must be false for the instance\n\t\t\t\tto perform NAT. For more information, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.

\n ", + "locationName": "sourceDestCheck" + }, + "Hypervisor": { + "type": "string", + "enum": [ + "ovm", + "xen" + ], + "documentation": "\n

The hypervisor type of the instance.

\n ", + "locationName": "hypervisor" + }, + "NetworkInterfaces": { + "type": "list", + "documentation": "\n

[EC2-VPC] One or more network interfaces for the instance.

\n ", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a network interface.

\n ", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

The description.

\n ", + "locationName": "description" + }, + "OwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the AWS account that created the network interface.

\n ", + "locationName": "ownerId" + }, + "Status": { + "type": "string", + "enum": [ + "available", + "attaching", + "in-use", + "detaching" + ], + "documentation": "\n\t\t

The status of the network interface.

\n ", + "locationName": "status" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The IP address of the network interface within the subnet.

\n ", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n\t\t

The private DNS name.

\n ", + "locationName": "privateDnsName" + }, + "SourceDestCheck": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether to validate network traffic to or from this network interface.

\n ", + "locationName": "sourceDestCheck" + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

One or more security groups.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "documentation": "\n\t\t

The network interface attachment.

\n ", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface attachment.

\n ", + "locationName": "attachmentId" + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The index of the device on the instance for the network interface attachment.

\n ", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The attachment state.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n\t\t

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the network interface is deleted when the instance is terminated.

\n ", + "locationName": "deleteOnTermination" + } + } + }, + "Association": { + "type": "structure", + "documentation": "\n\t\t

The association information for an Elastic IP associated with the network interface.

\n ", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The address of the Elastic IP address bound to the network interface.

\n ", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n\t\t

The public DNS name.

\n ", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the owner of the Elastic IP address.

\n ", + "locationName": "ipOwnerId" + } + } + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

The private IP addresses associated with the network interface.

\n ", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a private IP address.

\n ", + "locationName": "item", + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP address of the network interface.

\n ", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n\t\t

The private DNS name.

\n ", + "locationName": "privateDnsName" + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this IP address is the primary private IP address \n\t\t of the network interface.

\n ", + "locationName": "primary" + }, + "Association": { + "type": "structure", + "documentation": "\n\t\t

The association information for an Elastic IP address for the network interface.

\n ", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The address of the Elastic IP address bound to the network interface.

\n ", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n\t\t

The public DNS name.

\n ", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the owner of the Elastic IP address.

\n ", + "locationName": "ipOwnerId" + } + } + } + } + } + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "documentation": "\n

The IAM instance profile associated with the instance.

\n ", + "locationName": "iamInstanceProfile", + "members": { + "Arn": { + "type": "string", + "documentation": "\n

The Amazon Resource Name (ARN) of the instance profile.

\n ", + "locationName": "arn" + }, + "Id": { + "type": "string", + "documentation": "\n

The ID of the instance profile.

\n ", + "locationName": "id" + } + } + }, + "EbsOptimized": { + "type": "boolean", + "documentation": "\n

Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal I/O performance. This optimization\n\t\t\t\tisn't available with all instance types. Additional usage charges apply when\n\t\t\t\tusing an EBS Optimized instance.

\n ", + "locationName": "ebsOptimized" + }, + "SriovNetSupport": { + "type": "string", + "documentation": "\n

Specifies whether enhanced networking is enabled.

\n ", + "locationName": "sriovNetSupport" + } + } + } + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

\n ", + "locationName": "nextToken" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of your instances.

\n

If you specify one or more instance IDs, Amazon EC2 returns information for those\n instances. If you do not specify instance IDs, Amazon EC2 returns information for\n all relevant instances. If you specify an instance ID that is not valid, an error is returned.\n If you specify an instance that you do not own, it is not included in the returned\n results.

\n

Recently terminated instances might appear in the returned results. This interval\n is usually less than one hour.

\n \n \n Example 1\n This example describes all instances owned by your AWS account. The\n example response shows information for one instance.\n https://ec2.amazonaws.com/?Action=DescribeInstances\n&AUTHPARAMS\n \n <DescribeInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>fdcdcab1-ae5c-489e-9c33-4637c5dda355</requestId>\n <reservationSet>\n <item>\n <reservationId>r-1a2b3c4d</reservationId>\n <ownerId>123456789012</ownerId>\n <groupSet>\n <item>\n <groupId>sg-1a2b3c4d</groupId>\n <groupName>my-security-group</groupName>\n </item>\n </groupSet>\n <instancesSet>\n <item>\n <instanceId>i-1a2b3c4d</instanceId>\n <imageId>ami-1a2b3c4d</imageId>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <privateDnsName/>\n <dnsName/>\n <reason/>\n <keyName>my-key-pair</keyName>\n <amiLaunchIndex>0</amiLaunchIndex>\n <productCodes/>\n <instanceType>c1.medium</instanceType>\n <launchTime>YYYY-MM-DDTHH:MM:SS+0000</launchTime>\n <placement>\n <availabilityZone>us-west-2a</availabilityZone>\n <groupName/>\n <tenancy>default</tenancy>\n </placement>\n <platform>windows</platform>\n <monitoring>\n <state>disabled</state>\n </monitoring>\n <subnetId>subnet-1a2b3c4d</subnetId>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <privateIpAddress>10.0.0.12</privateIpAddress>\n <ipAddress>46.51.219.63</ipAddress>\n <sourceDestCheck>true</sourceDestCheck>\n <groupSet>\n <item>\n <groupId>sg-1a2b3c4d</groupId>\n <groupName>my-security-group</groupName>\n </item>\n </groupSet>\n <architecture>x86_64</architecture>\n <rootDeviceType>ebs</rootDeviceType>\n <rootDeviceName>/dev/sda1</rootDeviceName>\n <blockDeviceMapping>\n <item>\n <deviceName>/dev/sda1</deviceName>\n <ebs>\n <volumeId>vol-1a2b3c4d</volumeId>\n <status>attached</status>\n <attachTime>YYYY-MM-DDTHH:MM:SS.SSSZ</attachTime>\n <deleteOnTermination>true</deleteOnTermination>\n </ebs>\n </item>\n </blockDeviceMapping>\n <virtualizationType>hvm</virtualizationType>\n <clientToken>ABCDE1234567890123</clientToken>\n <tagSet>\n <item>\n <key>Name</key>\n <value>Windows Instance</value>\n </item>\n </tagSet>\n <hypervisor>xen</hypervisor>\n <networkInterfaceSet>\n <item>\n <networkInterfaceId>eni-1a2b3c4d</networkInterfaceId>\n <subnetId>subnet-1a2b3c4d</subnetId>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <description>Primary network interface</description>\n <ownerId>123456789012</ownerId>\n <status>in-use</status>\n <macAddress>1b:2b:3c:4d:5e:6f</macAddress>\n <privateIpAddress>10.0.0.12</privateIpAddress>\n <sourceDestCheck>true</sourceDestCheck>\n <groupSet>\n <item>\n <groupId>sg-1a2b3c4d</groupId>\n <groupName>my-security-group</groupName>\n </item>\n </groupSet>\n <attachment>\n <attachmentId>eni-attach-1a2b3c4d</attachmentId>\n <deviceIndex>0</deviceIndex>\n <status>attached</status>\n <attachTime>YYYY-MM-DDTHH:MM:SS+0000</attachTime>\n <deleteOnTermination>true</deleteOnTermination>\n </attachment>\n <association>\n <publicIp>198.51.100.63</publicIp>\n <ipOwnerId>123456789012</ipOwnerId>\n </association>\n <privateIpAddressesSet>\n <item>\n <privateIpAddress>10.0.0.12</privateIpAddress>\n <primary>true</primary>\n <association>\n <publicIp>198.51.100.63</publicIp>\n <ipOwnerId>123456789012</ipOwnerId>\n </association>\n </item>\n <item>\n <privateIpAddress>10.0.0.14</privateIpAddress>\n <primary>false</primary>\n <association>\n <publicIp>198.51.100.177</publicIp>\n <ipOwnerId>123456789012</ipOwnerId>\n </association>\n </item>\n </privateIpAddressesSet>\n </item>\n </networkInterfaceSet>\n </item>\n </instancesSet>\n </item>\n </reservationSet>\n </DescribeInstancesResponse>\n \n \n Example 2\n This example describes only the instances that have the m1.small or m1.large instance type and an attached Amazon EBS volume that will be deleted on termination.\n https://ec2.amazonaws.com/?Action=DescribeInstances\n&Filter.1.Name=instance-type\n&Filter.1.Value.1=m1.small\n&Filter.1.Value.2=m1.large\n&Filter.2.Name=block-device-mapping.status\n&Filter.2.Value.1=attached\n&Filter.3.Name=block-device-mapping.delete-on-termination\n&Filter.3.Value.1=true\n&AUTHPARAMS\n \n \n Example 3\n This example describes all instances that are running in a VPC.\n https://ec2.amazonaws.com/?Action=DescribeInstances\n&Filter.1.Name=vpc-id\n&Filter.1.Value.1=*\n&AUTHPARAMS\n \n \n Example 4\n This example describes any instances that have a tag with the key Owner,\n regardless of the value of the tag.\n https://ec2.amazonaws.com/?Action=DescribeInstances\n&Filter.1.Name=tag-key\n&Filter.1.Value.1=Owner\n&AUTHPARAMS\n \n \n Example\n This example lists only the instances that have a tag with the key\n Owner and the value DbAdmin.\n https://ec2.amazonaws.com/?Action=DescribeInstances\n&Filter.1.Name=tag:Owner\n&Filter.1.Value.1=DbAdmin\n&AUTHPARAMS\n \n \n " + }, + "DescribeInternetGateways": { + "name": "DescribeInternetGateways", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InternetGatewayIds": { + "type": "list", + "documentation": "\n\t\t

One or more Internet gateway IDs.

\n\t\t

Default: Describes all your Internet gateways.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InternetGatewayId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "InternetGateways": { + "type": "list", + "documentation": "\n\t\t

Information about one or more Internet gateways.

\n ", + "locationName": "internetGatewaySet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an Internet gateway.

\n ", + "locationName": "item", + "members": { + "InternetGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Internet gateway.

\n ", + "locationName": "internetGatewayId" + }, + "Attachments": { + "type": "list", + "documentation": "\n\t\t

Any VPCs attached to the Internet gateway.

\n ", + "locationName": "attachmentSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes the attachment of a VPC to an Internet gateway.

\n ", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The current state of the attachment.

\n ", + "locationName": "state" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the Internet gateway.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your Internet gateways.

\n \n \n Example\n This example describes all your Internet gateways.\n https://ec2.amazonaws.com/?Action=DescribeInternetGateways\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n igw-eaad4883EXAMPLE\n \n \n vpc-11ad4878\n available\n \n \n \n \n \n\n \n \n " + }, + "DescribeKeyPairs": { + "name": "DescribeKeyPairs", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "KeyNames": { + "type": "list", + "documentation": "\n

One or more key pair names.

\n

Default: Describes all your key pairs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "KeyName" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "KeyPairs": { + "type": "list", + "documentation": "\n

Information about one or more key pairs.

\n ", + "locationName": "keySet", + "member": { + "type": "structure", + "documentation": "\n

Describes a key pair.

\n ", + "locationName": "item", + "members": { + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair.

\n ", + "locationName": "keyName" + }, + "KeyFingerprint": { + "type": "string", + "documentation": "\n

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. \n If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

\n ", + "locationName": "keyFingerprint" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of your key pairs.

\n

For more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes the keypair with name my-key-pair.\n https://ec2.amazonaws.com/?Action=DescribeKeyPairs\n&KeyName.1=my-key-pair\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n my-key-pair\n 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f\n \n \n\n \n \n Example\n This example filters the response to include only key pairs whose names include the string Dave.\n https://ec2.amazonaws.com/?Action=DescribeKeyPairs\n&Filter.1.Name=key-name\n&Filter.1.Value.1=*Dave*\n&AUTHPARAMS\n \n \n " + }, + "DescribeNetworkAcls": { + "name": "DescribeNetworkAcls", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkAclIds": { + "type": "list", + "documentation": "\n\t\t

One or more network ACL IDs.

\n\t\t

Default: Describes all your network ACLs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "NetworkAclId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "NetworkAcls": { + "type": "list", + "documentation": "\n\t\t

Information about one or more network ACLs.

\n ", + "locationName": "networkAclSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a network ACL.

\n ", + "locationName": "item", + "members": { + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network ACL.

\n ", + "locationName": "networkAclId" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC for the network ACL.

\n ", + "locationName": "vpcId" + }, + "IsDefault": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this is the default network ACL for the VPC.

\n ", + "locationName": "default" + }, + "Entries": { + "type": "list", + "documentation": "\n\t\t

One or more entries (rules) in the network ACL.

\n ", + "locationName": "entrySet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an entry in a network ACL.

\n ", + "locationName": "item", + "members": { + "RuleNumber": { + "type": "integer", + "documentation": "\n\t\t

The rule number for the entry. ACL entries are processed in ascending order by rule number.

\n ", + "locationName": "ruleNumber" + }, + "Protocol": { + "type": "string", + "documentation": "\n\t\t

The protocol. A value of -1 means all protocols.

\n ", + "locationName": "protocol" + }, + "RuleAction": { + "type": "string", + "enum": [ + "allow", + "deny" + ], + "documentation": "\n\t\t

Indicates whether to allow or deny the traffic that matches the rule.

\n ", + "locationName": "ruleAction" + }, + "Egress": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

\n ", + "locationName": "egress" + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The network range to allow or deny, in CIDR notation.

\n ", + "locationName": "cidrBlock" + }, + "IcmpTypeCode": { + "type": "structure", + "documentation": "\n\t\t

ICMP protocol: The ICMP type and code.

\n ", + "locationName": "icmpTypeCode", + "members": { + "Type": { + "type": "integer", + "documentation": "\n\t\t

The ICMP code. A value of -1 means all codes for the specified ICMP type.

\n ", + "locationName": "type" + }, + "Code": { + "type": "integer", + "documentation": "\n\t\t

The ICMP type. A value of -1 means all types.

\n ", + "locationName": "code" + } + } + }, + "PortRange": { + "type": "structure", + "documentation": "\n\t\t

TCP or UDP protocols: The range of ports the rule applies to.

\n ", + "locationName": "portRange", + "members": { + "From": { + "type": "integer", + "documentation": "\n\t\t

The first port in the range.

\n ", + "locationName": "from" + }, + "To": { + "type": "integer", + "documentation": "\n\t\t

The last port in the range.

\n ", + "locationName": "to" + } + } + } + } + } + }, + "Associations": { + "type": "list", + "documentation": "\n\t\t

Any associations between the network ACL and one or more subnets

\n ", + "locationName": "associationSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an association between a network ACL and a subnet.

\n ", + "locationName": "item", + "members": { + "NetworkAclAssociationId": { + "type": "string", + "documentation": "\n\t\t

The ID of the association between a network ACL and a subnet.

\n ", + "locationName": "networkAclAssociationId" + }, + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network ACL.

\n ", + "locationName": "networkAclId" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the network ACL.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your network ACLs.

\n\t\t

For more information about network ACLs, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example describes all your network ACLs.\n https://ec2.amazonaws.com/?Action=DescribeNetworkAcls\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n acl-5566953c\n vpc-5266953b\n true\n \n \n 100\n all\n allow\n true\n 0.0.0.0/0\n \n \n 32767\n all\n deny\n true\n 0.0.0.0/0\n \n \n 100\n all\n allow\n false\n 0.0.0.0/0\n \n \n 32767\n all\n deny\n false\n 0.0.0.0/0\n \n \n \n \n \n \n acl-5d659634\n vpc-5266953b\n false\n \n \n 110\n 6\n allow\n true\n 0.0.0.0/0\n \n 49152\n 65535\n \n \n \n 32767\n all\n deny\n true\n 0.0.0.0/0\n \n \n 110\n 6\n allow\n false\n 0.0.0.0/0\n \n 80\n 80\n \n \n \n 120\n 6\n allow\n false\n 0.0.0.0/0\n \n 443\n 443\n \n \n \n 32767\n all\n deny\n false\n 0.0.0.0/0\n \n \n \n \n aclassoc-5c659635\n acl-5d659634\n subnet-ff669596\n \n \n aclassoc-c26596ab\n acl-5d659634\n subnet-f0669599\n \n \n \n \n \n\n \n \n " + }, + "DescribeNetworkInterfaceAttribute": { + "name": "DescribeNetworkInterfaceAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n

The ID of the network interface.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ], + "documentation": "\n

The attribute of the network interface.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "Description": { + "type": "structure", + "documentation": "\n\t\t

The description of the network interface.

\n ", + "locationName": "description", + "members": { + "Value": { + "type": "string", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "SourceDestCheck": { + "type": "structure", + "documentation": "\n\t\t

Indicates whether source/destination checking is enabled.

\n ", + "locationName": "sourceDestCheck", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

The security groups associated with the network interface.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "documentation": "\n\t\t

The attachment (if any) of the network interface.

\n ", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface attachment.

\n ", + "locationName": "attachmentId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "documentation": "\n\t\t

The AWS account ID of the owner of the instance.

\n ", + "locationName": "instanceOwnerId" + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The device index of the network interface attachment on the instance.

\n ", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The attachment state.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n\t\t

The timestamp indicating when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the network interface is deleted when the instance is terminated.

\n ", + "locationName": "deleteOnTermination" + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes a network interface attribute. You can specify only one attribute at a\n\t\t\t\ttime.

\n \n \n Example\n This example describes the sourceDestCheck attribute of the specified network interface.\n https://ec2.amazonaws.com/?Action=DescribeNetworkInterfaceAttribute\n&NetworkInterfaceId=eni-686ea200\n&Attribute=sourceDestCheck\n&AUTHPARAMS\n <DescribeNetworkInterfaceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a20c6b2-d71c-45fb-bba7-37306850544b</requestId>\n <networkInterfaceId>eni-686ea200</networkInterfaceId>\n <sourceDestCheck>\n <value>true</value>\n </sourceDestCheck>\n</DescribeNetworkInterfaceAttributeResponse>\n \n \n " + }, + "DescribeNetworkInterfaces": { + "name": "DescribeNetworkInterfaces", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkInterfaceIds": { + "type": "list", + "documentation": "\n\t\t

One or more network interface IDs.

\n\t\t

Default: Describes all your network interfaces.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "NetworkInterfaceId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "NetworkInterfaces": { + "type": "list", + "documentation": "\n\t\t

Information about one or more network interfaces.

\n ", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a network interface.

\n ", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n\t\t

The Availability Zone.

\n ", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

A description.

\n ", + "locationName": "description" + }, + "OwnerId": { + "type": "string", + "documentation": "\n\t\t

The AWS account ID of the owner of the network interface.

\n ", + "locationName": "ownerId" + }, + "RequesterId": { + "type": "string", + "documentation": "\n\t\t

The ID of the entity that launched the instance on your behalf (for example, AWS\n\t\t\t\tManagement Console or Auto Scaling).

\n ", + "locationName": "requesterId" + }, + "RequesterManaged": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the network interface is being managed by AWS.

\n ", + "locationName": "requesterManaged" + }, + "Status": { + "type": "string", + "enum": [ + "available", + "attaching", + "in-use", + "detaching" + ], + "documentation": "\n\t\t

The status of the network interface.

\n ", + "locationName": "status" + }, + "MacAddress": { + "type": "string", + "documentation": "\n\t\t

The MAC address.

\n ", + "locationName": "macAddress" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The IP address of the network interface within the subnet.

\n ", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n\t\t

The private DNS name.

\n ", + "locationName": "privateDnsName" + }, + "SourceDestCheck": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether traffic to or from the instance is validated.

\n ", + "locationName": "sourceDestCheck" + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

Any security groups for the network interface.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "documentation": "\n\t\t

The network interface attachment.

\n ", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface attachment.

\n ", + "locationName": "attachmentId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "documentation": "\n\t\t

The AWS account ID of the owner of the instance.

\n ", + "locationName": "instanceOwnerId" + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The device index of the network interface attachment on the instance.

\n ", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The attachment state.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n\t\t

The timestamp indicating when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the network interface is deleted when the instance is terminated.

\n ", + "locationName": "deleteOnTermination" + } + } + }, + "Association": { + "type": "structure", + "documentation": "\n\t\t

The association information for an Elastic IP associated with the network interface.

\n ", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The address of the Elastic IP address bound to the network interface.

\n ", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n\t\t

The public DNS name.

\n\t", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Elastic IP address owner.

\n ", + "locationName": "ipOwnerId" + }, + "AllocationId": { + "type": "string", + "documentation": "\n\t\t

The allocation ID.

\n ", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "documentation": "\n\t\t

The association ID.

\n ", + "locationName": "associationId" + } + } + }, + "TagSet": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the network interface.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

The private IP addresses associated with the network interface.

\n ", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes the private IP address of a network interface.

\n ", + "locationName": "item", + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP address.

\n ", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n\t\t

The private DNS name.

\n ", + "locationName": "privateDnsName" + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this IP address is the primary private IP address of the network interface.

\n ", + "locationName": "primary" + }, + "Association": { + "type": "structure", + "documentation": "\n\t\t

The association information for an Elastic IP address associated with the network interface.

\n ", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The address of the Elastic IP address bound to the network interface.

\n ", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n\t\t

The public DNS name.

\n\t", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Elastic IP address owner.

\n ", + "locationName": "ipOwnerId" + }, + "AllocationId": { + "type": "string", + "documentation": "\n\t\t

The allocation ID.

\n ", + "locationName": "allocationId" + }, + "AssociationId": { + "type": "string", + "documentation": "\n\t\t

The association ID.

\n ", + "locationName": "associationId" + } + } + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your network interfaces.

\n \n \n Example\n This example describes all your network interfaces.\n https://ec2.amazonaws.com/?Action=DescribeNetworkInterfaces\n&AUTHPARAMS\n <DescribeNetworkInterfacesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>fc45294c-006b-457b-bab9-012f5b3b0e40</requestId>\n <networkInterfaceSet>\n <item>\n <networkInterfaceId>eni-0f62d866</networkInterfaceId>\n <subnetId>subnet-c53c87ac</subnetId>\n <vpcId>vpc-cc3c87a5</vpcId>\n <availabilityZone>api-southeast-1b</availabilityZone>\n <description/>\n <ownerId>053230519467</ownerId>\n <requesterManaged>false</requesterManaged>\n <status>in-use</status>\n <macAddress>02:81:60:cb:27:37</macAddress>\n <privateIpAddress>10.0.0.146</privateIpAddress>\n <sourceDestCheck>true</sourceDestCheck>\n <groupSet>\n <item>\n <groupId>sg-3f4b5653</groupId>\n <groupName>default</groupName>\n </item>\n </groupSet>\n <attachment>\n <attachmentId>eni-attach-6537fc0c</attachmentId>\n <instanceId>i-22197876</instanceId>\n <instanceOwnerId>053230519467</instanceOwnerId>\n <deviceIndex>0</deviceIndex>\n <status>attached</status>\n <attachTime>2012-07-01T21:45:27.000Z</attachTime>\n <deleteOnTermination>true</deleteOnTermination>\n </attachment>\n <tagSet/>\n <privateIpAddressesSet>\n <item>\n <privateIpAddress>10.0.0.146</privateIpAddress>\n <primary>true</primary>\n </item>\n <item>\n <privateIpAddress>10.0.0.148</privateIpAddress>\n <primary>false</primary>\n </item>\n <item>\n <privateIpAddress>10.0.0.150</privateIpAddress>\n <primary>false</primary>\n </item>\n </privateIpAddressesSet>\n </item>\n <item>\n <networkInterfaceId>eni-a66ed5cf</networkInterfaceId>\n <subnetId>subnet-cd8a35a4</subnetId>\n <vpcId>vpc-f28a359b</vpcId>\n <availabilityZone>ap-southeast-1b</availabilityZone>\n <description>Primary network interface</description>\n <ownerId>053230519467</ownerId>\n <requesterManaged>false</requesterManaged>\n <status>in-use</status>\n <macAddress>02:78:d7:00:8a:1e</macAddress>\n <privateIpAddress>10.0.1.233</privateIpAddress>\n <sourceDestCheck>true</sourceDestCheck>\n <groupSet>\n <item>\n <groupId>sg-a2a0b2ce</groupId>\n <groupName>quick-start-1</groupName>\n </item>\n </groupSet>\n <attachment>\n <attachmentId>eni-attach-a99c57c0</attachmentId>\n <instanceId>i-886401dc</instanceId>\n <instanceOwnerId>053230519467</instanceOwnerId>\n <deviceIndex>0</deviceIndex>\n <status>attached</status>\n <attachTime>2012-06-27T20:08:44.000Z</attachTime>\n <deleteOnTermination>true</deleteOnTermination>\n </attachment>\n <tagSet/>\n <privateIpAddressesSet>\n <item>\n <privateIpAddress>10.0.1.233</privateIpAddress>\n <primary>true</primary>\n </item>\n <item>\n <privateIpAddress>10.0.1.20</privateIpAddress>\n <primary>false</primary>\n </item>\n </privateIpAddressesSet>\n </item>\n </networkInterfaceSet>\n</DescribeNetworkInterfacesResponse>\n \n \n " + }, + "DescribePlacementGroups": { + "name": "DescribePlacementGroups", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupNames": { + "type": "list", + "documentation": "\n

One or more placement group names.

\n

Default: Describes all your placement groups, or only those otherwise specified.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "GroupName" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "PlacementGroups": { + "type": "list", + "documentation": "\n

One or more placement groups.

\n ", + "locationName": "placementGroupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a placement group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the placement group.

\n ", + "locationName": "groupName" + }, + "Strategy": { + "type": "string", + "enum": [ + "cluster" + ], + "documentation": "\n

The placement strategy.

\n ", + "locationName": "strategy" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n

The state of the placement group.

\n ", + "locationName": "state" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of your placement groups. For more information about\n\t\t\t\tplacement groups and cluster instances, see\n\t\t\t\tCluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes the placement group named XYZ-cluster.\n https://ec2.amazonaws.com/?Action=DescribePlacementGroups\n&GroupName.1=XYZ-cluster\n&AUTHPARAMS\n \n d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE\n \n \n XYZ-cluster\n cluster\n available\n \n \n\n \n \n Example\n This example filters the response to include only placement groups that\n include the string Project in the name.\n https://ec2.amazonaws.com/?Action=DescribePlacementGroups\n&Filter.1.Name=group-name\n&Filter.1.Value=*Project*\n&AUTHPARAMS\n \n d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE\n \n \n Project-cluster\n cluster\n available\n \n \n\n \n \n " + }, + "DescribeRegions": { + "name": "DescribeRegions", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "RegionNames": { + "type": "list", + "documentation": "\n

The names of one or more regions.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "RegionName" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Regions": { + "type": "list", + "documentation": "\n

Information about one or more regions.

\n ", + "locationName": "regionInfo", + "member": { + "type": "structure", + "documentation": "\n

Describes a region.

\n ", + "locationName": "item", + "members": { + "RegionName": { + "type": "string", + "documentation": "\n

The name of the region.

\n ", + "locationName": "regionName" + }, + "Endpoint": { + "type": "string", + "documentation": "\n

The region service endpoint.

\n ", + "locationName": "regionEndpoint" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": " \n

Describes one or more regions that are currently available to you.

\n

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

\n \n \n Example 1\n This example displays information about all regions.\n https://ec2.amazonaws.com/?Action=DescribeRegions\n&AUTHPARAMS\n \n \n Example 2\n This example displays information about the specified regions only.\n https://ec2.amazonaws.com/?Action=DescribeRegions\n&RegionName.1=us-east-1\n&RegionName.2=eu-west-1\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n us-east-1\n ec2.us-east-1.amazonaws.com\n \n \n eu-west-1\n ec2.eu-west-1amazonaws.com\n \n \n\n \n \n " + }, + "DescribeReservedInstances": { + "name": "DescribeReservedInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ReservedInstancesIds": { + "type": "list", + "documentation": "\n

One or more Reserved Instance IDs.

\n

Default: Describes all your Reserved Instances, or only those otherwise specified.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ReservedInstancesId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "OfferingType": { + "type": "string", + "enum": [ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization" + ], + "documentation": "\n

The Reserved Instance offering type.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstances": { + "type": "list", + "documentation": "\n

A list of Reserved Instances.

\n ", + "locationName": "reservedInstancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance.

\n ", + "locationName": "item", + "members": { + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance.

\n ", + "locationName": "reservedInstancesId" + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type on which the Reserved Instance can be used.

\n ", + "locationName": "instanceType" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone in which the Reserved Instance can be used.

\n ", + "locationName": "availabilityZone" + }, + "Start": { + "type": "timestamp", + "documentation": "\n

The date and time the Reserved Instance started.

\n ", + "locationName": "start" + }, + "End": { + "type": "timestamp", + "documentation": "\n

The time when the Reserved Instance expires.

\n ", + "locationName": "end" + }, + "Duration": { + "type": "long", + "documentation": "\n

The duration of the Reserved Instance, in seconds.

\n ", + "locationName": "duration" + }, + "UsagePrice": { + "type": "float", + "documentation": "\n

The usage price of the Reserved Instance, per hour.

\n ", + "locationName": "usagePrice" + }, + "FixedPrice": { + "type": "float", + "documentation": "\n

The purchase price of the Reserved Instance.

\n ", + "locationName": "fixedPrice" + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

The number of Reserved Instances purchased.

\n ", + "locationName": "instanceCount" + }, + "ProductDescription": { + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\n

The Reserved Instance description.

\n ", + "locationName": "productDescription" + }, + "State": { + "type": "string", + "enum": [ + "payment-pending", + "active", + "payment-failed", + "retired" + ], + "documentation": "\n

The state of the Reserved Instance purchase.

\n ", + "locationName": "state" + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "InstanceTenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n

The tenancy of the reserved instance.

\n ", + "locationName": "instanceTenancy" + }, + "CurrencyCode": { + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\n

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.

\n ", + "locationName": "currencyCode" + }, + "OfferingType": { + "type": "string", + "enum": [ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization" + ], + "documentation": "\n

The Reserved Instance offering type.

\n ", + "locationName": "offeringType" + }, + "RecurringCharges": { + "type": "list", + "documentation": "\n

The recurring charge tag assigned to the resource.

\n ", + "locationName": "recurringCharges", + "member": { + "type": "structure", + "documentation": "\n

Describes a recurring charge.

\n ", + "locationName": "item", + "members": { + "Frequency": { + "type": "string", + "enum": [ + "Hourly" + ], + "documentation": "\n

The frequency of the recurring charge.

\n ", + "locationName": "frequency" + }, + "Amount": { + "type": "double", + "documentation": "\n

The amount of the recurring charge.

\n ", + "locationName": "amount" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of the Reserved Instances that you purchased.

\n

For more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes Reserved Instances owned by your account.\n https://ec2.amazonaws.com/?Action=DescribeReservedInstances\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n ...\n \n e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE\n m1.xlarge\n us-east-1b\n 31536000\n 61.0\n 0.034\n 3\n Linux/UNIX\n active \n default\n USD\n Light Utilization\n \n \n ...\n \n\n \n \n Example\n This example filters the response to include only one-year, m1.small Linux/UNIX Reserved Instances. \n If you want Linux/UNIX Reserved Instances specifically for use with a VPC, set the product description to \n Linux/UNIX (Amazon VPC).\n https://ec2.amazonaws.com/?Action=DescribeReservedInstances\n&Filter.1.Name=duration\n&Filter.1.Value.1=31536000\n&Filter.2.Name=instance-type\n&Filter.2.Value.1=m1.small\n&Filter.3.Name=product-description\n&Filter.3.Value.1=Linux%2FUNIX\n&AUTHPARAMS\n \n \n " + }, + "DescribeReservedInstancesListings": { + "name": "DescribeReservedInstancesListings", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

One or more Reserved Instance IDs.

\n " + }, + "ReservedInstancesListingId": { + "type": "string", + "documentation": "\n

One or more Reserved Instance Listing IDs.

\n " + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesListings": { + "type": "list", + "documentation": "\n

Information about the Reserved Instance listing.

\n ", + "locationName": "reservedInstancesListingsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance listing.

\n ", + "locationName": "item", + "members": { + "ReservedInstancesListingId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance listing.

\n ", + "locationName": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance.

\n ", + "locationName": "reservedInstancesId" + }, + "CreateDate": { + "type": "timestamp", + "documentation": "\n

The time the listing was created.

\n ", + "locationName": "createDate" + }, + "UpdateDate": { + "type": "timestamp", + "documentation": "\n

The last modified timestamp of the listing.

\n ", + "locationName": "updateDate" + }, + "Status": { + "type": "string", + "enum": [ + "active", + "pending", + "cancelled", + "closed" + ], + "documentation": "\n

The status of the Reserved Instance listing.

\n ", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.

\n ", + "locationName": "statusMessage" + }, + "InstanceCounts": { + "type": "list", + "documentation": "\n

The number of instances in this state.

\n ", + "locationName": "instanceCounts", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance listing state.

\n ", + "locationName": "item", + "members": { + "State": { + "type": "string", + "enum": [ + "available", + "sold", + "cancelled", + "pending" + ], + "documentation": "\n

The states of the listed Reserved Instances.

\n ", + "locationName": "state" + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

he number of listed Reserved Instances in the state specified by the state.

\n ", + "locationName": "instanceCount" + } + } + } + }, + "PriceSchedules": { + "type": "list", + "documentation": "\n

The price of the Reserved Instance listing.

\n ", + "locationName": "priceSchedules", + "member": { + "type": "structure", + "documentation": "\n

Describes the price for a Reserved Instance.

\n ", + "locationName": "item", + "members": { + "Term": { + "type": "long", + "documentation": "\n

The number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.

\n ", + "locationName": "term" + }, + "Price": { + "type": "double", + "documentation": "\n

The fixed price for the term.

\n ", + "locationName": "price" + }, + "CurrencyCode": { + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\n

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

\n ", + "locationName": "currencyCode" + }, + "Active": { + "type": "boolean", + "documentation": "\n

The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.

\n

A specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.

\n ", + "locationName": "active" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "ClientToken": { + "type": "string", + "documentation": "\n

The idempotency token you provided when you created the listing.

\n ", + "locationName": "clientToken" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

\n

For more information, see Reserved Instance Marketplace \n in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example shows all the listings associated with your account.\n https://ec2.amazonaws.com/?Action=DescribeReservedInstancesListings\n&AUTHPARAMS\n \n cec5c904-8f3a-4de5-8f5a-ff7f9EXAMPLE\n \n \n 253dfbf9-c335-4808-b956-d942cEXAMPLE\n e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE\n 2012-07-06T19:35:29.000Z\n 2012-07-06T19:35:30.000Z\n active\n ACTIVE\n \n \n Available\n 20\n \n \n Sold\n 0\n \n \n Cancelled\n 0\n \n \n Pending\n 0\n \n \n \n \n 8\n 480.0\n USD\n false\n \n \n 7\n 420.0\n USD\n false\n \n \n 6\n 360.0\n USD\n active\n \n \n 5\n 300.0\n USD\n false\n \n \n 4\n 240.0\n USD\n false\n \n \n 3\n 180.0\n USD\n false\n \n \n 2\n 120.0\n USD\n false\n \n \n 1\n 60.0\n USD\n false\n \n \n \n myclienttoken1\n \n \n\n \n \n " + }, + "DescribeReservedInstancesModifications": { + "name": "DescribeReservedInstancesModifications", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesModificationIds": { + "type": "list", + "documentation": "\n

IDs for the submitted modification request.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ReservedInstancesModificationId" + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The token for the next page of data.

\n " + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesModifications": { + "type": "list", + "documentation": "\n

The Reserved Instance modification information.

\n ", + "locationName": "reservedInstancesModificationsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance modification.

\n ", + "locationName": "item", + "members": { + "ReservedInstancesModificationId": { + "type": "string", + "documentation": "\n

A unique ID for the Reserved Instance modification.

\n ", + "locationName": "reservedInstancesModificationId" + }, + "ReservedInstancesIds": { + "type": "list", + "documentation": "\n

The IDs of one or more Reserved Instances.

\n ", + "locationName": "reservedInstancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes the ID of a Reserved Instance.

\n ", + "locationName": "item", + "members": { + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance.

\n ", + "locationName": "reservedInstancesId" + } + } + } + }, + "ModificationResults": { + "type": "list", + "documentation": "\n

Contains target configurations along with their corresponding new Reserved Instance IDs.

\n ", + "locationName": "modificationResultSet", + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "item", + "members": { + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

\n ", + "locationName": "reservedInstancesId" + }, + "TargetConfiguration": { + "type": "structure", + "documentation": "\n

The target Reserved Instances configurations supplied as part of the modification request.

\n ", + "locationName": "targetConfiguration", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone for the modified Reserved Instances.

\n ", + "locationName": "availabilityZone" + }, + "Platform": { + "type": "string", + "documentation": "\n

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

\n ", + "locationName": "platform" + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

The number of modified Reserved Instances.

\n ", + "locationName": "instanceCount" + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type for the modified Reserved Instances.

\n ", + "locationName": "instanceType" + } + } + } + } + } + }, + "CreateDate": { + "type": "timestamp", + "documentation": "\n

The time when the modification request was created.

\n ", + "locationName": "createDate" + }, + "UpdateDate": { + "type": "timestamp", + "documentation": "\n

The time when the modification request was last updated.

\n ", + "locationName": "updateDate" + }, + "EffectiveDate": { + "type": "timestamp", + "documentation": "\n

The time for the modification to become effective.

\n ", + "locationName": "effectiveDate" + }, + "Status": { + "type": "string", + "documentation": "\n

The status of the Reserved Instances modification request.

\n ", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The reason for the status.

\n ", + "locationName": "statusMessage" + }, + "ClientToken": { + "type": "string", + "documentation": "\n

A unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.

\n ", + "locationName": "clientToken" + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The token for the next page of data.

\n ", + "locationName": "nextToken" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

\n \n \n Example 1\n https://ec2.amazonaws.com/?Action=DescribeReservedInstancesModifications\n&AUTHPARAMS\n \n \n Example 2\n This example filters the response to include only Reserved Instances modification requests with status processing.\n https://ec2.amazonaws.com/?Action=DescribeReservedInstancesModifications\n&Filter.1.Name=status\n&Filter.1.Value.1=processing\n&AUTHPARAMS\n \n \n " + }, + "DescribeReservedInstancesOfferings": { + "name": "DescribeReservedInstancesOfferings", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ReservedInstancesOfferingIds": { + "type": "list", + "documentation": "\n

One or more Reserved Instances offering IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ReservedInstancesOfferingId" + } + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type on which the Reserved Instance can be used.\n\t\t\t\tFor more information, see Instance Types \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n " + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone in which the Reserved Instance can be used.

\n " + }, + "ProductDescription": { + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\n

The Reserved Instance description. Instances that include (Amazon VPC) \n in the description are for use with Amazon VPC.

\n " + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "InstanceTenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n

The tenancy of the Reserved Instance offering. A Reserved Instance\n\t\t\t\twith dedicated tenancy runs on single-tenant hardware and can\n\t\t\t\tonly be launched within a VPC.

\n

Default: default

\n " + }, + "OfferingType": { + "type": "string", + "enum": [ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization" + ], + "documentation": "\n

The Reserved Instance offering type.

\n " + }, + "NextToken": { + "type": "string", + "documentation": "\n

The token to use when requesting the next paginated set of offerings.

\n " + }, + "MaxResults": { + "type": "integer", + "documentation": "\n

The maximum number of offerings to return.

\n " + }, + "IncludeMarketplace": { + "type": "boolean", + "documentation": "\n

Include Marketplace offerings in the response.

\n " + }, + "MinDuration": { + "type": "long", + "documentation": "\n

The minimum duration (in seconds) to filter when searching for offerings.

\n " + }, + "MaxDuration": { + "type": "long", + "documentation": "\n

The maximum duration (in seconds) to filter when searching for offerings.

\n " + }, + "MaxInstanceCount": { + "type": "integer", + "documentation": "\n

The maximum number of instances to filter when searching for offerings.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesOfferings": { + "type": "list", + "documentation": "\n

A list of Reserved Instances offerings.

\n ", + "locationName": "reservedInstancesOfferingsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance offering.

\n ", + "locationName": "item", + "members": { + "ReservedInstancesOfferingId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance offering.

\n ", + "locationName": "reservedInstancesOfferingId" + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type on which the Reserved Instance can be used.

\n ", + "locationName": "instanceType" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone in which the Reserved Instance can be used.

\n ", + "locationName": "availabilityZone" + }, + "Duration": { + "type": "long", + "documentation": "\n

The duration of the Reserved Instance, in seconds.

\n ", + "locationName": "duration" + }, + "UsagePrice": { + "type": "float", + "documentation": "\n

The usage price of the Reserved Instance, per hour.

\n ", + "locationName": "usagePrice" + }, + "FixedPrice": { + "type": "float", + "documentation": "\n

The purchase price of the Reserved Instance.

\n ", + "locationName": "fixedPrice" + }, + "ProductDescription": { + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\n

The Reserved Instance description.

\n ", + "locationName": "productDescription" + }, + "InstanceTenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n

The tenancy of the reserved instance.

\n ", + "locationName": "instanceTenancy" + }, + "CurrencyCode": { + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\n

The currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is USD.

\n ", + "locationName": "currencyCode" + }, + "OfferingType": { + "type": "string", + "enum": [ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization" + ], + "documentation": "\n

The Reserved Instance offering type.

\n ", + "locationName": "offeringType" + }, + "RecurringCharges": { + "type": "list", + "documentation": "\n

The recurring charge tag assigned to the resource.

\n ", + "locationName": "recurringCharges", + "member": { + "type": "structure", + "documentation": "\n

Describes a recurring charge.

\n ", + "locationName": "item", + "members": { + "Frequency": { + "type": "string", + "enum": [ + "Hourly" + ], + "documentation": "\n

The frequency of the recurring charge.

\n ", + "locationName": "frequency" + }, + "Amount": { + "type": "double", + "documentation": "\n

The amount of the recurring charge.

\n ", + "locationName": "amount" + } + } + } + }, + "Marketplace": { + "type": "boolean", + "documentation": "\n

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. \n If it's a Reserved Instance Marketplace offering, this is true.

\n ", + "locationName": "marketplace" + }, + "PricingDetails": { + "type": "list", + "documentation": "\n

The pricing details of the Reserved Instance offering.

\n ", + "locationName": "pricingDetailsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a Reserved Instance offering.

\n ", + "locationName": "item", + "members": { + "Price": { + "type": "double", + "documentation": "\n

The price per instance.

\n ", + "locationName": "price" + }, + "Count": { + "type": "integer", + "documentation": "\n

The number of instances available for the price.

\n ", + "locationName": "count" + } + } + } + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The next paginated set of results to return.

\n ", + "locationName": "nextToken" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes Reserved Instance offerings that are available for purchase. With \n\t\t\t\tReserved Instances, you purchase the right to launch instances for a\n\t\t\t\tperiod of time. During that time period, you do not receive insufficient capacity\n\t\t\t\terrors, and you pay a lower usage rate than the rate charged for On-Demand\n\t\t\t\tinstances for the actual time used.

\n

For more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example Describing Reserved Instance Marketplace Offerings Only\n This example requests a list of Linux/Unix, Light Utilization Reserved\n\t\t\t\t\tInstances that are available through the Reserved Instance Marketplace only.\n\t\t\t\t\tWhen using the Query API, all strings must be URL-encoded.\n https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&Filter.0.Name=marketplace\n&Filter.0.Value.1=true\n&IncludeMarketplace=true\n&OfferingType=Light+Utilization\n&ProductDescription=Linux%2FUNIX\n&Version=2013-10-01\n&AUTHPARAMS\n 2bc7dafa-dafd-4257-bdf9-c0814EXAMPLE\n \n \n a6ce8269-7b8c-42cd-a7f5-0841cEXAMPLE\n m1.large\n us-east-1a\n 90720000\n 96.03\n 0.027\n Linux/UNIX\n default\n USD\n Light Utilization\n \n true\n \n \n 96.03\n 1\n \n \n \n \n 2bc7dafa-dafd-4257-bdf9-c0814EXAMPLE\n m1.xlarge\n us-east-1b\n 28512000\n 61.0\n 0.034\n Linux/UNIX\n default\n USD\n Light Utilization\n \n \n Hourly\n 0.29\n \n \n true\n \n \n 61.0\n 2\n \n \n \n \n\n \n \n Example Describing AWS Offerings Only\n This example lists AWS offerings only.\n https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&IncludeMarketplace=false\n&AUTHPARAMS\n \n \n \n Example Using Tokens to Manage Results\n You can use pagination support to query the results sequentially and in parts. \n Specify the maximum number of results that are returned in the response. Then, each paginated response \n contains a token that can be provided as input to a subsequent DescribeReservedInstancesOfferings call \n to fetch the next page. (Make sure that you use URL encoding for the token value.)\n https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&MaxResults=5\n&AUTHPARAMS\n\n\n d072f652-cc57-458c-89e0-e6c02EXAMPLE\n \n ...\n \n 649fd0c8-7846-46b8-8f84-a6400EXAMPLE\n m1.large\n us-east-1a\n 94608000\n 1200.0\n 0.0\n Linux/UNIX (Amazon VPC)\n default\n USD\n Heavy Utilization\n \n \n Hourly\n 0.052\n \n \n false\n \n \n \n e5a2ff3b-a4f3-477c-8928-dbd00EXAMPLE\n m1.large\n us-east-1a\n 94608000\n 1000.0\n 0.076\n Linux/UNIX (Amazon VPC)\n default\n USD\n Medium Utilization\n \n false\n \n \n ...\n \n h/C8YKPQBHEjW8xKz1827/Zzyb0VqsqkjRo3TqhFYeE=\n\n\nhttps://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&MaxResults=5\n&NextToken=h%2FC8YKPQBHEjW8xKz1827%2FZzyb0VqsqkjRo3TqhFYeE%3D\n&AUTHPARAMS\n \n \n Example Using Filters\n This example filters the response to include only one-year, m1.small or m1.large \n Linux/UNIX Reserved Instances. If you want Linux/UNIX Reserved Instances specifically for use with a VPC, \n set the product description to Linux/UNIX (Amazon VPC).\n https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&Filter.1.Name=duration\n&Filter.1.Value.1=31536000\n&Filter.2.Name=instance-type\n&Filter.2.Value.1=m1.small\n&Filter.2.Value.2=m1.large\n&Filter.3.Name=product-description\n&Filter.3.Value.1=Linux%2FUNIX\n&AUTHPARAMS\n \n \n " + }, + "DescribeRouteTables": { + "name": "DescribeRouteTables", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "RouteTableIds": { + "type": "list", + "documentation": "\n\t\t

One or more route table IDs.

\n\t\t

Default: Describes all your route tables.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "RouteTableId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "RouteTables": { + "type": "list", + "documentation": "\n\t\t

Information about one or more route tables.

\n ", + "locationName": "routeTableSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a route table.

\n ", + "locationName": "item", + "members": { + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table.

\n ", + "locationName": "routeTableId" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "Routes": { + "type": "list", + "documentation": "\n\t\t

The routes in the route table.

\n ", + "locationName": "routeSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a route in a route table.

\n ", + "locationName": "item", + "members": { + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block used for the destination match.

\n ", + "locationName": "destinationCidrBlock" + }, + "GatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of a gateway attached to your VPC.

\n ", + "locationName": "gatewayId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n\t\t

The ID of a NAT instance in your VPC.

\n ", + "locationName": "instanceId" + }, + "InstanceOwnerId": { + "type": "string", + "documentation": "\n\t\t

The AWS account ID of the owner of the instance.

\n ", + "locationName": "instanceOwnerId" + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of the VPC peering connection.

\n ", + "locationName": "vpcPeeringConnectionId" + }, + "State": { + "type": "string", + "enum": [ + "active", + "blackhole" + ], + "documentation": "\n\t\t

The state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).

\n ", + "locationName": "state" + }, + "Origin": { + "type": "string", + "enum": [ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ], + "documentation": "\n

Describes how the route was created.

\n \n ", + "locationName": "origin" + } + } + } + }, + "Associations": { + "type": "list", + "documentation": "\n\t\t

The associations between the route table and one or more subnets.

\n ", + "locationName": "associationSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an association between a route table and a subnet.

\n ", + "locationName": "item", + "members": { + "RouteTableAssociationId": { + "type": "string", + "documentation": "\n\t\t

The ID of the association between a route table and a subnet.

\n ", + "locationName": "routeTableAssociationId" + }, + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table.

\n ", + "locationName": "routeTableId" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + }, + "Main": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this is the main route table.

\n ", + "locationName": "main" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the route table.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "PropagatingVgws": { + "type": "list", + "documentation": "\n\t\t

Any virtual private gateway (VGW) propagating routes.

\n ", + "locationName": "propagatingVgwSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a virtual private gateway propagating route.

\n ", + "locationName": "item", + "members": { + "GatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway (VGW).

\n ", + "locationName": "gatewayId" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your route tables.

\n\t\t

For more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example describes all your route tables.\n The first route table in the returned list is the VPC's main route table. Its\n\t\t\t\t association ID represents the association between the table and the VPC.\n https://ec2.amazonaws.com/?Action=DescribeRouteTables\n&AUTHPARAMS\n \n 6f570b0b-9c18-4b07-bdec-73740dcf861a\n \n \n rtb-13ad487a\n vpc-11ad4878\n \n \n 10.0.0.0/22\n local\n active\n CreateRouteTable\n \n \n \n \n rtbassoc-12ad487b\n rtb-13ad487a\n
true
\n \n \n \n \n \n rtb-f9ad4890\n vpc-11ad4878\n \n \n 10.0.0.0/22\n local\n active\n CreateRouteTable\n \n \n 0.0.0.0/0\n igw-eaad4883\n active\n \n \n \n \n rtbassoc-faad4893\n rtb-f9ad4890\n subnet-15ad487c\n \n \n \n \n \n\n \n \n " + }, + "DescribeSecurityGroups": { + "name": "DescribeSecurityGroups", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupNames": { + "type": "list", + "documentation": "\n

[EC2-Classic, default VPC] One or more security group names.

\n

Default: Describes all your security groups.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "GroupName" + } + }, + "GroupIds": { + "type": "list", + "documentation": "\n

One or more security group IDs.

\n

Default: Describes all your security groups.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "GroupId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "SecurityGroups": { + "type": "list", + "documentation": "\n

Information about one or more security groups.

\n ", + "locationName": "securityGroupInfo", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group

\n ", + "locationName": "item", + "members": { + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the owner of the security group.

\n ", + "locationName": "ownerId" + }, + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + }, + "Description": { + "type": "string", + "documentation": "\n

A description of the security group.

\n ", + "locationName": "groupDescription" + }, + "IpPermissions": { + "type": "list", + "documentation": "\n

One or more inbound rules associated with the security group.

\n ", + "locationName": "ipPermissions", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a security group rule.

\n ", + "locationName": "item", + "members": { + "IpProtocol": { + "type": "string", + "documentation": "\n\t\t

The protocol.

\n\t\t

When you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.

\n ", + "locationName": "ipProtocol" + }, + "FromPort": { + "type": "integer", + "documentation": "\n\t\t

The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.

\n ", + "locationName": "fromPort" + }, + "ToPort": { + "type": "integer", + "documentation": "\n\t\t

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.

\n ", + "locationName": "toPort" + }, + "UserIdGroupPairs": { + "type": "list", + "documentation": "\n\t\t

One or more security group and AWS account ID pairs.

\n ", + "locationName": "groups", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group and AWS account ID pair for EC2-Classic.

\n ", + "locationName": "item", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The ID of an AWS account.

\n ", + "locationName": "userId" + }, + "GroupName": { + "type": "string", + "documentation": "\n

The ID of the security group owned by the specified AWS account.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The name of the security group in the specified AWS account.

\n ", + "locationName": "groupId" + } + } + } + }, + "IpRanges": { + "type": "list", + "documentation": "\n\t\t

One or more IP ranges.

\n ", + "locationName": "ipRanges", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an IP range.

\n ", + "locationName": "item", + "members": { + "CidrIp": { + "type": "string", + "documentation": "\n\t\t

The CIDR range. You can either specify a CIDR range or a source security group, not both.

\n ", + "locationName": "cidrIp" + } + } + } + } + } + } + }, + "IpPermissionsEgress": { + "type": "list", + "documentation": "\n

[EC2-VPC] One or more outbound rules associated with the security group.

\n ", + "locationName": "ipPermissionsEgress", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a security group rule.

\n ", + "locationName": "item", + "members": { + "IpProtocol": { + "type": "string", + "documentation": "\n\t\t

The protocol.

\n\t\t

When you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.

\n ", + "locationName": "ipProtocol" + }, + "FromPort": { + "type": "integer", + "documentation": "\n\t\t

The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.

\n ", + "locationName": "fromPort" + }, + "ToPort": { + "type": "integer", + "documentation": "\n\t\t

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.

\n ", + "locationName": "toPort" + }, + "UserIdGroupPairs": { + "type": "list", + "documentation": "\n\t\t

One or more security group and AWS account ID pairs.

\n ", + "locationName": "groups", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group and AWS account ID pair for EC2-Classic.

\n ", + "locationName": "item", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The ID of an AWS account.

\n ", + "locationName": "userId" + }, + "GroupName": { + "type": "string", + "documentation": "\n

The ID of the security group owned by the specified AWS account.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The name of the security group in the specified AWS account.

\n ", + "locationName": "groupId" + } + } + } + }, + "IpRanges": { + "type": "list", + "documentation": "\n\t\t

One or more IP ranges.

\n ", + "locationName": "ipRanges", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an IP range.

\n ", + "locationName": "item", + "members": { + "CidrIp": { + "type": "string", + "documentation": "\n\t\t

The CIDR range. You can either specify a CIDR range or a source security group, not both.

\n ", + "locationName": "cidrIp" + } + } + } + } + } + } + }, + "VpcId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The ID of the VPC for the security group.

\n ", + "locationName": "vpcId" + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the security group.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of your security groups.

\n

A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example returns information about two security groups that are configured\n\t\t\t\t\tfor the account.\n https://ec2.amazonaws.com/?Action=DescribeSecurityGroups\n&GroupName.1=WebServers\n&GroupName.2=RangedPortsBySource\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n 123456789012\n sg-1a2b3c4d\n WebServers\n Web Servers\n \n \n \n tcp\n 80\n 80\n \n \n \n 0.0.0.0/0\n \n \n \n \n \n \n \n 123456789012\n sg-2a2b3c4d\n RangedPortsBySource\n Group A\n \n \n tcp\n 6000\n 7000\n \n \n 123456789012\n sg-3a2b3c4d\n Group B\n \n \n \n \n \n \n \n \n\n \n \n Example 2\n This example describes all security groups that grant access over TCP specifically on port 22 \n from instances associated with app_server_group or database_group.\n https://ec2.amazonaws.com/?Action=DescribeSecurityGroups\n&Filter.1.Name=ip-permission.protocol\n&Filter.1.Value.1=tcp\n&Filter.2.Name=ip-permission.from-port\n&Filter.2.Value.1=22\n&Filter.3.Name=ip-permission.to-port\n&Filter.3.Value.1=22\n&Filter.4.Name=ip-permission.group-name\n&Filter.4.Value.1=app_server_group\n&Filter.4.Value.2=database_group\n&AUTHPARAMS\n \n \n " + }, + "DescribeSnapshotAttribute": { + "name": "DescribeSnapshotAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SnapshotId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS snapshot.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "productCodes", + "createVolumePermission" + ], + "documentation": "\n

The snapshot attribute you would like to view.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS snapshot.

\n ", + "locationName": "snapshotId" + }, + "CreateVolumePermissions": { + "type": "list", + "documentation": "\n

A list of permissions for creating volumes from the snapshot.

\n ", + "locationName": "createVolumePermission", + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "item", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.

\n ", + "locationName": "userId" + }, + "Group": { + "type": "string", + "enum": [ + "all" + ], + "documentation": "\n

The specific group that is to be added or removed from a volume's list of create volume\n permissions.

\n ", + "locationName": "group" + } + } + } + }, + "ProductCodes": { + "type": "list", + "documentation": "\n

A list of product codes.

\n ", + "locationName": "productCodes", + "member": { + "type": "structure", + "documentation": "\n

Describes a product code.

\n ", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "documentation": "\n

The product code.

\n ", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\n

The type of product code.

\n ", + "locationName": "type" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a\n time.

\n

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes permissions for a snapshot with the ID of\n snap-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=DescribeSnapshotAttribute\n&SnapshotId=snap-1a2b3c4d\n&Attribute=createVolumePermission\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n snap-1a2b3c4d\n \n \n all\n \n \n\n \n \n " + }, + "DescribeSnapshots": { + "name": "DescribeSnapshots", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SnapshotIds": { + "type": "list", + "documentation": "\n

One or more snapshot IDs.

\n

Default: Describes snapshots for which you have launch permissions.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SnapshotId" + } + }, + "OwnerIds": { + "type": "list", + "documentation": "\n

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Owner" + } + }, + "RestorableByUserIds": { + "type": "list", + "documentation": "\n

One or more AWS accounts IDs that can create volumes from the snapshot.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "RestorableBy" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Snapshots": { + "type": "list", + "documentation": "\n ", + "locationName": "snapshotSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a snapshot.

\n ", + "locationName": "item", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n ", + "locationName": "snapshotId" + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "completed", + "error" + ], + "documentation": "\n

The snapshot state.

\n ", + "locationName": "status" + }, + "StartTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the snapshot was initiated.

\n ", + "locationName": "startTime" + }, + "Progress": { + "type": "string", + "documentation": "\n

The progress of the snapshot, as a percentage.

\n ", + "locationName": "progress" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the Amazon EBS snapshot owner.

\n ", + "locationName": "ownerId" + }, + "Description": { + "type": "string", + "documentation": "\n

The description for the snapshot.

\n ", + "locationName": "description" + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n ", + "locationName": "volumeSize" + }, + "OwnerAlias": { + "type": "string", + "documentation": "\n

The AWS account alias (for example, amazon, self) or AWS account ID\n that owns the snapshot.

\n ", + "locationName": "ownerAlias" + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the snapshot.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the snapshot is encrypted.

\n ", + "locationName": "encrypted" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include \n public snapshots available for any AWS account to launch, private\n snapshots that you own, and private snapshots owned by another AWS account but for which\n you've been given explicit create volume permissions.

\n

The create volume permissions fall into the following categories:

\n \n

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or\n AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all\n snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot\n ID for which you do not have access, it is not included in the returned results.

\n

If you specify one or more snapshot owners, only snapshots from the specified owners and for\n which you have access are returned. The results can include the AWS account IDs of the specified\n owners, amazon for snapshots owned by Amazon, or self for snapshots\n that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions for\n those users are returned. You can specify AWS account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes a snapshot with an ID of\n snap-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=DescribeSnapshots\n&SnapshotId=snap-1a2b3c4d\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n snap-1a2b3c4d\n vol-1a2b3c4d\n pending\n YYYY-MM-DDTHH:MM:SS.SSSZ\n 80%\n 111122223333\n 15\n Daily Backup\n true\n \n \n \n\n \n \n Example\n This example filters the response to include only snapshots with the\n pending status, and that are also tagged with a value that includes the string\n db_.\n https://ec2.amazonaws.com/?Action=DescribeSnapshots\n&Filter.1.Name=status\n&Filter.1.Value.1=pending\n&Filter.2.Name=tag-value\n&Filter.2.Value.1=*db_*\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n snap-1a2b3c4d\n vol-1a2b3c4d\n pending\n YYYY-MM-DDTHH:MM:SS.SSSZ\n 30%\n 111122223333\n 15\n Daily Backup\n \n \n Purpose\n demo_db_14_backup\n \n \n true\n \n \n\n \n \n " + }, + "DescribeSpotDatafeedSubscription": { + "name": "DescribeSpotDatafeedSubscription", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "SpotDatafeedSubscription": { + "type": "structure", + "documentation": "\n

The Spot Instance datafeed subscription.

\n ", + "locationName": "spotDatafeedSubscription", + "members": { + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the account.

\n ", + "locationName": "ownerId" + }, + "Bucket": { + "type": "string", + "documentation": "\n

The Amazon S3 bucket where the Spot Instance datafeed is located.

\n ", + "locationName": "bucket" + }, + "Prefix": { + "type": "string", + "documentation": "\n

The prefix that is prepended to datafeed files.

\n ", + "locationName": "prefix" + }, + "State": { + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "documentation": "\n

The state of the Spot Instance datafeed subscription.

\n ", + "locationName": "state" + }, + "Fault": { + "type": "structure", + "documentation": "\n

The fault codes for the Spot Instance request, if any.

\n ", + "locationName": "fault", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The reason code for the Spot Instance state change.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

The message for the Spot Instance state change.

\n ", + "locationName": "message" + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the datafeed for Spot Instances. For more information, see\n\t\t\t\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes the datafeed for the account.\n https://ec2.amazonaws.com/?Action=DescribeSpotDatafeedSubscription\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n 123456789012\n my-s3-bucket\n spotdata_\n Active\n \n\n \n \n " + }, + "DescribeSpotInstanceRequests": { + "name": "DescribeSpotInstanceRequests", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SpotInstanceRequestIds": { + "type": "list", + "documentation": "\n

One or more Spot Instance request IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SpotInstanceRequestId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "SpotInstanceRequests": { + "type": "list", + "documentation": "\n

One or more Spot Instance requests.

\n ", + "locationName": "spotInstanceRequestSet", + "member": { + "type": "structure", + "documentation": "\n

Describe a Spot Instance request.

\n ", + "locationName": "item", + "members": { + "SpotInstanceRequestId": { + "type": "string", + "documentation": "\n

The ID of the Spot Instance request.

\n ", + "locationName": "spotInstanceRequestId" + }, + "SpotPrice": { + "type": "string", + "documentation": "\n

The maximum hourly price for any Spot Instance launched to fulfill the request.

\n ", + "locationName": "spotPrice" + }, + "Type": { + "type": "string", + "enum": [ + "one-time", + "persistent" + ], + "documentation": "\n

The Spot Instance request type.

\n ", + "locationName": "type" + }, + "State": { + "type": "string", + "enum": [ + "open", + "active", + "closed", + "cancelled", + "failed" + ], + "documentation": "\n

The state of the Spot Instance request. Spot bid status information can help you track your \n\t\t\t\tSpot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

\n ", + "locationName": "state" + }, + "Fault": { + "type": "structure", + "documentation": "\n

The fault codes for the Spot Instance request, if any.

\n ", + "locationName": "fault", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The reason code for the Spot Instance state change.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

The message for the Spot Instance state change.

\n ", + "locationName": "message" + } + } + }, + "Status": { + "type": "structure", + "documentation": "\n

The status code and status message describing the Spot Instance request.

\n ", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The status code of the request.

\n ", + "locationName": "code" + }, + "UpdateTime": { + "type": "timestamp", + "documentation": "\n

The time of the most recent status update.

\n ", + "locationName": "updateTime" + }, + "Message": { + "type": "string", + "documentation": "\n

The description for the status code for the Spot request.

\n ", + "locationName": "message" + } + } + }, + "ValidFrom": { + "type": "timestamp", + "documentation": "\n

The start date of the request. If this is a one-time request, the request becomes\n\t\t\t\tactive at this date and time and remains active until all\n\t\t\t\tinstances launch, the request expires, or the request is\n\t\t\t\tcanceled. If the request is persistent, the request becomes\n\t\t\t\tactive at this date and time and remains active until it expires\n\t\t\t\tor is canceled.

\n ", + "locationName": "validFrom" + }, + "ValidUntil": { + "type": "timestamp", + "documentation": "\n

The end date of the request. If this is a one-time request, the request remains\n\t\t\t\tactive until all instances launch, the request is canceled, or\n\t\t\t\tthis date is reached. If the request is persistent, it remains\n\t\t\t\tactive until it is canceled or this date is reached.

\n ", + "locationName": "validUntil" + }, + "LaunchGroup": { + "type": "string", + "documentation": "\n

The instance launch group. Launch groups are Spot Instances that launch\n\t\t\t\ttogether and terminate together.

\n ", + "locationName": "launchGroup" + }, + "AvailabilityZoneGroup": { + "type": "string", + "documentation": "\n

The Availability Zone group. If you specify the same Availability Zone group\n\t\t\t\tfor all Spot Instance requests, all Spot Instances are launched in the same\n\t\t\t\tAvailability Zone.

\n ", + "locationName": "availabilityZoneGroup" + }, + "LaunchSpecification": { + "type": "structure", + "documentation": "\n

Additional information for launching instances.

\n ", + "locationName": "launchSpecification", + "members": { + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n ", + "locationName": "imageId" + }, + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair.

\n ", + "locationName": "keyName" + }, + "SecurityGroups": { + "type": "list", + "documentation": "\n

One or more security groups.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "UserData": { + "type": "string", + "documentation": "\n

The Base64-encoded MIME user data to make available to the instances.

\n ", + "locationName": "userData" + }, + "AddressingType": { + "type": "string", + "documentation": "\n

\n ", + "locationName": "addressingType" + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type.

\n ", + "locationName": "instanceType" + }, + "Placement": { + "type": "structure", + "documentation": "\n

The placement information for the instance.

\n ", + "locationName": "placement", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone.

\n ", + "locationName": "availabilityZone" + }, + "GroupName": { + "type": "string", + "documentation": "\n

The Availability Zone group name.

\n ", + "locationName": "groupName" + } + } + }, + "KernelId": { + "type": "string", + "documentation": "\n

The ID of the kernel.

\n ", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "documentation": "\n

The ID of the RAM disk.

\n ", + "locationName": "ramdiskId" + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

One or more block device mapping entries.

\n ", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "item", + "members": { + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n ", + "locationName": "virtualName" + }, + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n ", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "locationName": "ebs", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n ", + "locationName": "snapshotId" + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

\n

Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.

\n ", + "locationName": "volumeSize" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.

\n

Default: standard

\n ", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the\n volume supports.

\n

Constraint: Range is 100 to 4000.

\n

Condition: Required when the volume type is io1; not used with\n standard or gp2 volumes.

\n ", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is encrypted.

\n ", + "locationName": "encrypted" + } + } + }, + "NoDevice": { + "type": "string", + "documentation": "\n

Suppresses the specified device included in the block device mapping of the AMI.

\n ", + "locationName": "noDevice" + } + } + } + }, + "MonitoringEnabled": { + "type": "boolean", + "documentation": "\n

Enables monitoring for the instance.

\n

Default: Disabled

\n ", + "locationName": "monitoringEnabled" + }, + "SubnetId": { + "type": "string", + "documentation": "\n

The ID of the subnet in which to launch the Spot Instance.

\n ", + "locationName": "subnetId" + }, + "NetworkInterfaces": { + "type": "list", + "documentation": "\n

One or more network interfaces.

\n ", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a network interface.

\n ", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The index of the device on the instance for the network interface attachment.

\n ", + "locationName": "deviceIndex" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet associated with the network string.

\n ", + "locationName": "subnetId" + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

The description of the network interface.

\n ", + "locationName": "description" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP address of the network interface.

\n ", + "locationName": "privateIpAddress" + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

The IDs of the security groups for the network interface.

\n ", + "locationName": "SecurityGroupId", + "member": { + "type": "string", + "documentation": null, + "locationName": "SecurityGroupId" + } + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

If set to true, the interface is deleted when the instance is terminated.

\n ", + "locationName": "deleteOnTermination" + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

One or more private IP addresses to assign to the network interface.

\n ", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a secondary private IP address for a network interface.

\n ", + "locationName": "item", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP addresses.

\n ", + "locationName": "privateIpAddress" + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the private IP address is the primary private IP address.

\n ", + "locationName": "primary" + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer", + "documentation": "\n\t\t

The number of secondary private IP addresses.

\n ", + "locationName": "secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress": { + "type": "boolean", + "documentation": "\n

Indicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.

\n ", + "locationName": "associatePublicIpAddress" + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "documentation": "\n

The IAM instance profile.

\n ", + "locationName": "iamInstanceProfile", + "members": { + "Arn": { + "type": "string", + "documentation": "\n

The Amazon Resource Name (ARN) of the instance profile.

\n ", + "locationName": "arn" + }, + "Name": { + "type": "string", + "documentation": "\n

The name of the instance profile.

\n ", + "locationName": "name" + } + } + }, + "EbsOptimized": { + "type": "boolean", + "documentation": "\n

Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.

\n

Default: false

\n ", + "locationName": "ebsOptimized" + } + } + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The instance ID, if an instance has been launched to fulfill the Spot Instance\n\t\t\t\trequest.

\n ", + "locationName": "instanceId" + }, + "CreateTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the Spot Instance request was created.

\n ", + "locationName": "createTime" + }, + "ProductDescription": { + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\n

The product description associated with the Spot Instance.

\n ", + "locationName": "productDescription" + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "LaunchedAvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone in which the bid is launched.

\n ", + "locationName": "launchedAvailabilityZone" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the Spot Instance requests that belong to your account. Spot Instances\n\t\t\t\tare instances that Amazon EC2 starts on your behalf when the maximum price that you\n\t\t\t\tspecify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price\n\t\t\t\tbased on available Spot Instance capacity and current Spot Instance requests. For\n\t\t\t\tmore information about Spot Instances, see \n\t\t\t\tSpot Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n

You can use DescribeSpotInstanceRequests to find a\n\t\t\t\trunning Spot Instance by examining the response. If the status of\n\t\t\t\tthe Spot Instance is fulfilled, the instance ID \n\t\t\t\tappears in the response and contains the identifier of the instance.\n\t\t\t\tAlternatively, you can use DescribeInstances with a filter to\n\t\t\t\tlook for instances where the instance lifecycle is spot.

\n \n \n Example for DescribeSpotInstanceRequests\n This example returns information about current Spot Instance requests.\n https://ec2.amazonaws.com/?Action=DescribeSpotInstanceRequests\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE\n \n \n sir-1a2b3c4d\n 0.09\n one-time\n active\n \n fulfilled\n YYYY-MM-DDTHH:MM:SS.000Z\n Your Spot request is fulfilled.\n \n \n ami-1a2b3c4d\n my-key-pair\n \n \n sg-1a2b3c4d\n websrv\n \n \n m1.small\n \n false\n \n false\n \n i-1a2b3c4d\n YYYY-MM-DDTHH:MM:SS.000Z\n Linux/UNIX\n us-east-1a\n \n \n\n \n \n Example for DescribeInstances\n Alternatively, you can use DescribeInstances as follows.\n https://ec2.amazonaws.com/?Action=DescribeInstances\n&Filter.1.Name=instance-lifecycle\n&Filter.1.Value.1=spot\n&AUTHPARAMS\n \n \n " + }, + "DescribeSpotPriceHistory": { + "name": "DescribeSpotPriceHistory", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "StartTime": { + "type": "timestamp", + "documentation": "\n

The start date and time of the Spot Price history data.

\n " + }, + "EndTime": { + "type": "timestamp", + "documentation": "\n

The end date and time of the Spot Price history data.

\n " + }, + "InstanceTypes": { + "type": "list", + "documentation": "\n

One or more instance types.

\n ", + "flattened": true, + "member": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": null, + "locationName": "InstanceType" + } + }, + "ProductDescriptions": { + "type": "list", + "documentation": "\n

One or more basic product descriptions.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ProductDescription" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone.

\n " + }, + "MaxResults": { + "type": "integer", + "documentation": "\n

The number of rows to return.

\n " + }, + "NextToken": { + "type": "string", + "documentation": "\n

The next set of rows to return.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "SpotPriceHistory": { + "type": "list", + "documentation": "\n

The historical Spot Prices.

\n ", + "locationName": "spotPriceHistorySet", + "member": { + "type": "structure", + "documentation": "\n

Describes the Spot Price.

\n ", + "locationName": "item", + "members": { + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type.

\n ", + "locationName": "instanceType" + }, + "ProductDescription": { + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\n

A general description of the AMI.

\n ", + "locationName": "productDescription" + }, + "SpotPrice": { + "type": "string", + "documentation": "\n

The maximum price you will pay to launch one or more Spot Instances.

\n ", + "locationName": "spotPrice" + }, + "Timestamp": { + "type": "timestamp", + "documentation": "\n

The date and time the request was created.

\n ", + "locationName": "timestamp" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone.

\n ", + "locationName": "availabilityZone" + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The string marking the next set of results. This is empty\n\t\t\t\tif there are no more results.

\n ", + "locationName": "nextToken" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the Spot Price history. Spot Instances are instances that Amazon EC2\n\t\t\t\tstarts on your behalf when the maximum price that you specify exceeds the current\n\t\t\t\tSpot Price. Amazon EC2 periodically sets the Spot Price based on available Spot\n\t\t\t\tInstance capacity and current Spot Instance requests. For more information about\n\t\t\t\tSpot Instances, see Spot\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.

\n

When you specify an Availability Zone, this operation describes the price history \n for the specified Availability Zone with the most recent set of prices listed first. \n If you don't specify an Availability Zone, you get the prices across all Availability Zones, \n starting with the most recent set. However, if you're using an API version earlier than 2011-05-15,\n you get the lowest price across the region for the specified time period. The prices \n returned are listed in chronological order, from the oldest to the most recent.

\n \n \n Example\n This example gets Spot Price history for a particular day in December 2009\n\t\t\t\t\tfor the specified Availability Zone.\n https://ec2.amazonaws.com/?Action=DescribeSpotPriceHistory\n&StartTime=2009-12-04T00:00:00.000Z\n&EndTime=2009-12-04T23:59:59.000Z\n&AvailabilityZone=us-east-1a\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n \n \n m1.small\n Linux/UNIX\n 0.287\n 2009-12-04T20:56:05.000Z\n us-east-1a\n \n \n m1.small\n Windows\n 0.033\n 2009-12-04T22:33:47.000Z\n us-east-1a\n \n \n \n\n \n \n Example with Filters\n This example uses filters to get the same results as the previous example.\n https://ec2.amazonaws.com/?Action=DescribeSpotPriceHistory\n&Filter.1.Name=timestamp\n&Filter.1.Value.1=2009-12-04*\n&Filter.2.Name=availability-zone\n&Filter.2.Value.1=us-east-1a\n&AUTHPARAMS\n \n \n " + }, + "DescribeSubnets": { + "name": "DescribeSubnets", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SubnetIds": { + "type": "list", + "documentation": "\n\t\t

One or more subnet IDs.

\n\t\t

Default: Describes all your subnets.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SubnetId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Subnets": { + "type": "list", + "documentation": "\n\t\t

Information about one or more subnets.

\n ", + "locationName": "subnetSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a subnet.

\n ", + "locationName": "item", + "members": { + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available" + ], + "documentation": "\n\t\t

The current state of the subnet.

\n ", + "locationName": "state" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC the subnet is in.

\n ", + "locationName": "vpcId" + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block assigned to the subnet.

\n ", + "locationName": "cidrBlock" + }, + "AvailableIpAddressCount": { + "type": "integer", + "documentation": "\n\t\t

The number of unused IP addresses in the subnet. Note that the IP addresses for any\n\t\t\t\tstopped instances are considered unavailable.

\n ", + "locationName": "availableIpAddressCount" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n\t\t

The Availability Zone of the subnet.

\n ", + "locationName": "availabilityZone" + }, + "DefaultForAz": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this is the default subnet for the Availability Zone.

\n ", + "locationName": "defaultForAz" + }, + "MapPublicIpOnLaunch": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether instances launched in this subnet receive a public IP address.

\n ", + "locationName": "mapPublicIpOnLaunch" + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the subnet.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your subnets.

\n\t\t

For more information about subnets, see Your VPC and Subnets\n\t\t\t in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example describes the subnets with the IDs subnet-9d4a7b6c and\n\t\t\t\t\tsubnet-6e7f829e.\n https://ec2.amazonaws.com/?Action=DescribeSubnets\n&SubnetId.1=subnet-9d4a7b6c\n&SubnetId.2=subnet-6e7f829e\n&AUTHPARAMS\n <DescribeSubnetsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <subnetSet>\n <item>\n <subnetId>subnet-9d4a7b6c</subnetId>\n <state>available</state>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <cidrBlock>10.0.1.0/24</cidrBlock>\n <availableIpAddressCount>251</availableIpAddressCount>\n <availabilityZone>us-east-1a</availabilityZone>\n <defaultForAz>false</defaultForAz>\n <mapPublicIpOnLaunch>false</mapPublicIpOnLaunch>\n <tagSet/>\n </item>\n <item>\n <subnetId>subnet-6e7f829e</subnetId>\n <state>available</state>\n <vpcId>vpc-1a2b3c4d>/vpcId>\n <cidrBlock>10.0.0.0/24</cidrBlock> \n <availableIpAddressCount>251</availableIpAddressCount>\n <availabilityZone>us-east-1a</availabilityZone>\n <defaultForAz>false</defaultForAz>\n <mapPublicIpOnLaunch>false</mapPublicIpOnLaunch>\n <tagSet/>\n </item>\n <subnetSet/>\n</DescribeSubnetsResponse>\n \n \n Example 2\n This example uses filters to describe any subnet you own that is\n\t\t\t\t\tin the VPC with the ID vpc-1a2b3c4d or vpc-6e7f8a92, and whose state is\n\t\t\t\t\tavailable.\n https://ec2.amazonaws.com/?Action=DescribeSubnets\t\t\t\t\t\t\n&Filter.1.Name=vpc-id\n&Filter.1.Value.1=vpc-1a2b3c4d\n&Filter.1.Value.2=vpc-6e7f8a92\n&Filter.2.Name=state\n&Filter.2.Value.1=available\n&AUTHPARAMS\n \n \n " + }, + "DescribeTags": { + "name": "DescribeTags", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "MaxResults": { + "type": "integer", + "documentation": "\n

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

\n " + }, + "NextToken": { + "type": "string", + "documentation": "\n

The token for the next set of items to return. (You received this token from a prior call.)

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Tags": { + "type": "list", + "documentation": "\n

A list of tags.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "ResourceId": { + "type": "string", + "documentation": "\n

The ID of the resource. For example, ami-1a2b3c4d.

\n ", + "locationName": "resourceId" + }, + "ResourceType": { + "type": "string", + "enum": [ + "customer-gateway", + "dhcp-options", + "image", + "instance", + "internet-gateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "snapshot", + "spot-instances-request", + "subnet", + "security-group", + "volume", + "vpc", + "vpn-connection", + "vpn-gateway" + ], + "documentation": "\n

The type of resource.

\n ", + "locationName": "resourceType" + }, + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n ", + "locationName": "value" + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

\n ", + "locationName": "nextToken" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of the tags for your EC2 resources.

\n

For more information about tags, see Tagging Your Resources in the\n Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes all the tags in your account.\n https://ec2.amazonaws.com/?Action=DescribeTags\n&AUTHPARAMS\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n \n ami-1a2b3c4d\n image\n webserver\n \n \n \n ami-1a2b3c4d\n image\n stack\n Production\n \n \n i-5f4e3d2a\n instance\n webserver\n \n \n \n i-5f4e3d2a\n instance\n stack\n Production\n \n \n i-12345678\n instance\n database_server\n \n \n \n i-12345678\n instance\n stack\n Test\n \n \n\n \n \n Example\n This example describes only the tags for the AMI with ID ami-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=DescribeTags\n&Filter.1.Name=resource-id\n&Filter.1.Value.1=ami-1a2b3c4d\n&AUTHPARAMS\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n \n ami-1a2b3c4d\n image\n webserver\n \n \n \n ami-1a2b3c4d\n image\n stack\n Production\n \n \n\n \n \n Example\n This example describes the tags for all your instances.\n https://ec2.amazonaws.com/?Action=DescribeTags\n&Filter.1.Name=resource-type\n&Filter.1.Value.1=instance\n&AUTHPARAMS\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n \n i-5f4e3d2a\n instance\n webserver\n \n \n \n i-5f4e3d2a\n instance\n stack\n Production\n \n \n i-12345678\n instance\n database_server\n \n \n \n i-12345678\n instance\n stack\n Test\n \n \n\n \n \n Example\n This example describes the tags for all your instances tagged with the key\n webserver. Note that you can use wildcards with\n filters, so you could specify the value as ?ebserver to\n find tags with the key webserver or\n Webserver.\n https://ec2.amazonaws.com/?Action=DescribeTags\n&Filter.1.Name=key\n&Filter.1.Value.1=webserver\n&AUTHPARAMS\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n \n i-5f4e3d2a\n instance\n webserver\n \n \n \n\n \n \n Example\n This example describes the tags for all your instances tagged with either\n stack=Test or stack=Production.\n https://ec2.amazonaws.com/?Action=DescribeTags\n&Filter.1.Name=resource-type\n&Filter.1.Value.1=instance\n&Filter.2.Name=key\n&Filter.2.Value.1=stack\n&Filter.3.Name=value\n&Filter.3.Value.1=Test\n&Filter.3.Value.2=Production\n&AUTHPARAMS\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE \n \n \n i-5f4e3d2a\n instance\n stack\n Production\n \n \n i-12345678\n instance\n stack\n Test\n \n \n\n \n \n Example\n This example describes the tags for all your instances tagged with Purpose=[empty\n string].\n https://ec2.amazonaws.com/?Action=DescribeTags\n&Filter.1.Name=resource-type\n&Filter.1.Value.1=instance\n&Filter.2.Name=key\n&Filter.2.Value.1=Purpose\n&Filter.3.Name=value\n&Filter.3.Value.1=\n&AUTHPARAMS\n \n \n " + }, + "DescribeVolumeAttribute": { + "name": "DescribeVolumeAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "autoEnableIO", + "productCodes" + ], + "documentation": "\n

The instance attribute.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "AutoEnableIO": { + "type": "structure", + "documentation": "\n

The state of autoEnableIO attribute.

\n ", + "locationName": "autoEnableIO", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "ProductCodes": { + "type": "list", + "documentation": "\n

A list of product codes.

\n ", + "locationName": "productCodes", + "member": { + "type": "structure", + "documentation": "\n

Describes a product code.

\n ", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "documentation": "\n

The product code.

\n ", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\n

The type of product code.

\n ", + "locationName": "type" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the specified attribute of the specified volume. You can specify only one attribute\n at a time.

\n

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes the autoEnableIO attribute of the volume\n vol-12345678.\n https://ec2.amazonaws.com/?Action=DescribeVolumeAttribute\n&Attribute=autoEnableIO\n&VolumeId=vol-12345678\n&AUTHPARAMS\n <DescribeVolumeAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE</requestId> \n <volumeId>vol-12345678</volumeId>\n <autoEnableIO>\n <value>false</value>\n </autoEnableIO>\n</DescribeVolumeAttributeResponse>\n \n \n Example\n This example describes the productCodes attribute of the volume\n vol-12345678.\n https://ec2.amazonaws.com/?Action=DescribeVolumeAttribute\n&Attribute=productCodes\n&VolumeId=vol-12345678\n&AUTHPARAMS\n <DescribeVolumeAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE</requestId> \n <volumeId>vol-12345678</volumeId>\n <productCodes>\n <item>\n <productCode>a1b2c3d4e5f6g7h8i9j10k11</productCode>\n <type>marketplace</type>\n </item>\n </productCodes>\n</DescribeVolumeAttributeResponse>\n \n \n " + }, + "DescribeVolumeStatus": { + "name": "DescribeVolumeStatus", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeIds": { + "type": "list", + "documentation": "\n

One or more volume IDs.

\n

Default: Describes all your volumes.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "VolumeId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The next paginated set of results to return using the pagination token\n returned by a previous call.

\n " + }, + "MaxResults": { + "type": "integer", + "documentation": "\n

The maximum number of paginated volume items per response.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VolumeStatuses": { + "type": "list", + "documentation": "\n

A list of volumes.

\n ", + "locationName": "volumeStatusSet", + "member": { + "type": "structure", + "documentation": "\n

Describes the volume status.

\n ", + "locationName": "item", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The volume ID.

\n ", + "locationName": "volumeId" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone of the volume.

\n ", + "locationName": "availabilityZone" + }, + "VolumeStatus": { + "type": "structure", + "documentation": "\n

The volume status.

\n ", + "locationName": "volumeStatus", + "members": { + "Status": { + "type": "string", + "enum": [ + "ok", + "impaired", + "insufficient-data" + ], + "documentation": "\n

The status of the volume.

\n ", + "locationName": "status" + }, + "Details": { + "type": "list", + "documentation": "\n

The details of the volume status.

\n ", + "locationName": "details", + "member": { + "type": "structure", + "documentation": "\n

Describes a volume status.

\n ", + "locationName": "item", + "members": { + "Name": { + "type": "string", + "enum": [ + "io-enabled", + "io-performance" + ], + "documentation": "\n

The name of the volume status.

\n ", + "locationName": "name" + }, + "Status": { + "type": "string", + "documentation": "\n

The intended status of the volume status.

\n ", + "locationName": "status" + } + } + } + } + } + }, + "Events": { + "type": "list", + "documentation": "\n

A list of events associated with the volume.

\n ", + "locationName": "eventsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a volume status event.

\n ", + "locationName": "item", + "members": { + "EventType": { + "type": "string", + "documentation": "\n

The type of this event.

\n ", + "locationName": "eventType" + }, + "Description": { + "type": "string", + "documentation": "\n

A description of the event.

\n ", + "locationName": "description" + }, + "NotBefore": { + "type": "timestamp", + "documentation": "\n

The earliest start time of the event.

\n ", + "locationName": "notBefore" + }, + "NotAfter": { + "type": "timestamp", + "documentation": "\n

The latest end time of the event.

\n ", + "locationName": "notAfter" + }, + "EventId": { + "type": "string", + "documentation": "\n

The ID of this event.

\n ", + "locationName": "eventId" + } + } + } + }, + "Actions": { + "type": "list", + "documentation": "\n

The details of the operation.

\n ", + "locationName": "actionsSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a volume status operation code.

\n ", + "locationName": "item", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The code identifying the operation, for example, enable-volume-io.

\n ", + "locationName": "code" + }, + "Description": { + "type": "string", + "documentation": "\n

A description of the operation.

\n ", + "locationName": "description" + }, + "EventType": { + "type": "string", + "documentation": "\n

The event type associated with this operation.

\n ", + "locationName": "eventType" + }, + "EventId": { + "type": "string", + "documentation": "\n

The ID of the event associated with this operation.

\n ", + "locationName": "eventId" + } + } + } + } + } + } + }, + "NextToken": { + "type": "string", + "documentation": "\n

The next paginated set of results to return.

\n ", + "locationName": "nextToken" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.

\n

The DescribeVolumeStatus operation provides the following information about the\n specified volumes:

\n

Status: Reflects the current status of the volume. The possible values are\n ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks may still be taking place on your\n volume at the time. We recommend that you retry the request. For more information on volume status,\n see Monitoring the Status of Your\n Volumes.

\n

Events: Reflect the cause of a volume status and may require you to take action.\n For example, if your volume returns an impaired status, then the volume event\n might be potential-data-inconsistency. This means that your volume has been\n affected by an issue with the underlying host, has all I/O operations disabled, and may have\n inconsistent data.

\n

Actions: Reflect the actions you may have to take in response to an event. For\n example, if the status of the volume is impaired and the volume event shows\n potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume for data\n consistency.

\n \n

Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)

\n \n \n \n Example\n This example describes the status of all the volumes associated with your\n account.\n https://ec2.amazonaws.com/?Action=DescribeVolumeStatus\n&AUTHPARAMS\n \n 5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE\n \n \n vol-11111111\n us-east-1d\n \n ok\n
\n \n io-enabled\n passed\n \n
\n \n \n \n vol-22222222\n us-east-1d\n \n impaired\n
\n \n io-enabled\n failed\n \n
\n \n \n \n evol-61a54008\n potential-data-inconsistency\n THIS IS AN EXAMPLE\n 2011-12-01T14:00:00.000Z\n 2011-12-01T15:00:00.000Z\n \n \n \n \n enable-volume-io\n evol-61a54008\n potential-data-inconsistency\n THIS IS AN EXAMPLE \n \n \n \n \n\n\n \n \n Example\n This example describes all the volumes in the us-east-1d\n Availability Zone with failed\n io-enabled status.\n https://ec2.amazonaws.com/?Action=DescribeVolumeStatus\n&Filter.1.Name=availability-zone\n&Filter.1.Value.1=us-east-1d\n&Filter.2.Name=volume-status.details-name\n&Filter.2.Value.1=io-enabled\n&Filter.3.Name=volume-status.details-status\n&Filter.3.Value.1=failed\n&AUTHPARAMS\n \n \n " + }, + "DescribeVolumes": { + "name": "DescribeVolumes", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeIds": { + "type": "list", + "documentation": "\n

One or more volume IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "VolumeId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Volumes": { + "type": "list", + "documentation": "\n ", + "locationName": "volumeSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a volume.

\n ", + "locationName": "item", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "Size": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiBs.

\n ", + "locationName": "size" + }, + "SnapshotId": { + "type": "string", + "documentation": "\n

The snapshot from which the volume was created, if applicable.

\n ", + "locationName": "snapshotId" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone for the volume.

\n ", + "locationName": "availabilityZone" + }, + "State": { + "type": "string", + "enum": [ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ], + "documentation": "\n

The volume state.

\n ", + "locationName": "status" + }, + "CreateTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when volume creation was initiated.

\n ", + "locationName": "createTime" + }, + "Attachments": { + "type": "list", + "documentation": "\n ", + "locationName": "attachmentSet", + "member": { + "type": "structure", + "documentation": "\n

Describes volume attachment details.

\n ", + "locationName": "item", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "Device": { + "type": "string", + "documentation": "\n

The device name.

\n ", + "locationName": "device" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n

The attachment state of the volume.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the volume.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

\n ", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the volume supports.

\n ", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the volume is encrypted.

\n ", + "locationName": "encrypted" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes the specified Amazon EBS volumes.

\n

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example describes all volumes associated with your account.\n https://ec2.amazonaws.com/?Action=DescribeVolumes\n&AUTHPARAMS\n <DescribeVolumesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <volumeSet>\n <item>\n <volumeId>vol-1a2b3c4d</volumeId>\n <size>80</size>\n <snapshotId/>\n <availabilityZone>us-east-1a</availabilityZone>\n <status>in-use</status>\n <createTime>YYYY-MM-DDTHH:MM:SS.SSSZ</createTime>\n <attachmentSet>\n <item>\n <volumeId>vol-1a2b3c4d</volumeId>\n <instanceId>i-1a2b3c4d</instanceId>\n <device>/dev/sdh</device>\n <status>attached</status>\n <attachTime>YYYY-MM-DDTHH:MM:SS.SSSZ</attachTime>\n <deleteOnTermination>false</deleteOnTermination>\n </item>\n </attachmentSet>\n <volumeType>standard</volumeType>\n <encrypted>true</encrypted>\n </item>\n </volumeSet>\n</DescribeVolumesResponse>\n \n \n " + }, + "DescribeVpcAttribute": { + "name": "DescribeVpcAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "enableDnsSupport", + "enableDnsHostnames" + ], + "documentation": "\n\t\t

The VPC attribute.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "EnableDnsSupport": { + "type": "structure", + "documentation": "\n\t\t

Indicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is true, the Amazon DNS server\n\t\t\t\tresolves DNS hostnames for your instances to their corresponding\n\t\t\t\tIP addresses; otherwise, it does not.

\n ", + "locationName": "enableDnsSupport", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n ", + "locationName": "value" + } + } + }, + "EnableDnsHostnames": { + "type": "structure", + "documentation": "\n\t\t

Indicates whether the instances launched in the VPC get DNS hostnames.\n\t\t\t\tIf this attribute is true, instances in the VPC get DNS hostnames;\n\t\t\t\totherwise, they do not.

\n ", + "locationName": "enableDnsHostnames", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n ", + "locationName": "value" + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

\n \n \n Example 1\n This example describes the enableDnsSupport attribute of the specified VPC.\n The sample response indicates that DNS resolution is supported.\n https://ec2.amazonaws.com/?Action=DescribeVpcAttribute\n&VpcId=vpc-1a2b3c4d\n&Attribute=enableDnsSupport\n&AUTHPARAMS\n <DescribeVpcAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpcId>vpc-1a2b3c4d</vpcId>\n  <enableDnsSupport>\n <value>true</value>\n </enableDnsSupport>\n</DescribeVpcAttributeResponse>\n \n \n Example 2\n This request describes the enableDnsHostnames attribute of the\n\t\t\t\t\tspecified VPC. The sample response indicates that DNS hostnames are supported.\n https://ec2.amazonaws.com/?Action=DescribeVpcAttribute\n&VpcId=vpc-1a2b3c4d\n&Attribute=enableDnsHostnames\n&AUTHPARAMS\n <DescribeVpcAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpcId>vpc-1a2b3c4d</vpcId>\n  <enableDnsHostnames>\n <value>true</value>\n </enableDnsHostnames>\n</DescribeVpcAttributeResponse>\n \n \n " + }, + "DescribeVpcPeeringConnections": { + "name": "DescribeVpcPeeringConnections", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcPeeringConnectionIds": { + "type": "list", + "documentation": "\n

One or more VPC peering connection IDs.

\n

Default: Describes all your VPC peering connections.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "VpcPeeringConnectionId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n

One or more filters.

\n \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpcPeeringConnections": { + "type": "list", + "documentation": "\n

Information about the VPC peering connections

\n ", + "locationName": "vpcPeeringConnectionSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a VPC peering connection.

\n ", + "locationName": "item", + "members": { + "AccepterVpcInfo": { + "type": "structure", + "documentation": "\n

The information of the peer VPC.

\n ", + "locationName": "accepterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "documentation": "\n

The CIDR block for the VPC.

\n ", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the VPC owner.

\n ", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC.

\n ", + "locationName": "vpcId" + } + } + }, + "ExpirationTime": { + "type": "timestamp", + "documentation": "\n

The time that an unaccepted VPC peering connection will expire.

\n ", + "locationName": "expirationTime" + }, + "RequesterVpcInfo": { + "type": "structure", + "documentation": "\n

The information of the requester VPC.

\n ", + "locationName": "requesterVpcInfo", + "members": { + "CidrBlock": { + "type": "string", + "documentation": "\n

The CIDR block for the VPC.

\n ", + "locationName": "cidrBlock" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The AWS account ID of the VPC owner.

\n ", + "locationName": "ownerId" + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC.

\n ", + "locationName": "vpcId" + } + } + }, + "Status": { + "type": "structure", + "documentation": "\n

The status of the VPC peering connection.

\n ", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The status of the VPC peering connection.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

A message that provides more information about the status, if applicable.

\n ", + "locationName": "message" + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of the VPC peering connection.

\n ", + "locationName": "vpcPeeringConnectionId" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Describes one or more of your VPC peering connections.

\n \n \n Example 1\n This example describes all of your VPC peering connections.\n https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections\n&AUTHPARAMS\n <DescribeVpcPeeringConnectionsResponse xmlns=http://ec2.amazonaws.com/doc/2014-06-15/\">\n<requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpcPeeringConnectionSet>\n <item>\n <vpcPeeringConnectionId>pcx-111aaa22</vpcPeeringConnectionId>\n <requesterVpcInfo>\n <ownerId>777788889999</ownerId>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <cidrBlock>172.31.0.0/16</cidrBlock>\n </requesterVpcInfo>\n <accepterVpcInfo>\n <ownerId>123456789012</ownerId>\n <vpcId>vpc-aa22cc33</vpcId>\n </accepterVpcInfo>\"\n <status>\n <code>pending-acceptance</code>\n <message>Pending Acceptance by 123456789012</message>\n </status>\n <expirationTime>2014-02-17T16:00:50.000Z</expirationTime>\n <tagSet/>\n </item>\n </vpcPeeringConnectionSet>\n</DescribeVpcPeeringConnectionsResponse>\n \n \n Example 2\n This example describes all of your VPC peering connections that are in the\n pending-acceptance state.\n https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections\n&Filter.1.Name=status-code\n&Filter.1.Value=pending-acceptance\n&AUTHPARAMS\n \n \n Example 3\n This example describes all of your VPC peering connections that have the tag\n Name=Finance or Name=Accounts.\n https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections\n&Filter.1.Name=tag:Name\n&Filter.1.Value.1=Finance\n&Filter.1.Value.2=Accounts\n&AUTHPARAMS\n \n \n Example 4\n This example describes all of the VPC peering connections for your specified VPC,\n vpc-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections\n&Filter.1.Name=requester-vpc-info.vpc-id\n&Filter.1.Value=vpc-1a2b3c4d\n&AUTHPARAMS\n \n \n " + }, + "DescribeVpcs": { + "name": "DescribeVpcs", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcIds": { + "type": "list", + "documentation": "\n\t\t

One or more VPC IDs.

\n\t\t

Default: Describes all your VPCs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "VpcId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Vpcs": { + "type": "list", + "documentation": "\n\t\t

Information about one or more VPCs.

\n ", + "locationName": "vpcSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a VPC.

\n ", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available" + ], + "documentation": "\n\t\t

The current state of the VPC.

\n ", + "locationName": "state" + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block for the VPC.

\n ", + "locationName": "cidrBlock" + }, + "DhcpOptionsId": { + "type": "string", + "documentation": "\n\t\t

The ID of the set of DHCP options you've associated with the VPC (or default\n\t\t\t\tif the default options are associated with the VPC).

\n ", + "locationName": "dhcpOptionsId" + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the VPC.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "InstanceTenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n\t\t

The allowed tenancy of instances launched into the VPC.

\n ", + "locationName": "instanceTenancy" + }, + "IsDefault": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the VPC is the default VPC.

\n ", + "locationName": "isDefault" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your VPCs.

\n \n \n Example 1\n This example describes the specified VPC.\n https://ec2.amazonaws.com/?Action=DescribeVpcs\n&VpcId.1=vpc-1a2b3c4d\n&AUTHPARAMS\n <DescribeVpcsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpcSet>\n <item>\n <vpcId>vpc-1a2b3c4d</vpcId>\n <state>available</state>\n <cidrBlock>10.0.0.0/23</cidrBlock> \n <dhcpOptionsId>dopt-7a8b9c2d</dhcpOptionsId> \n <instanceTenancy>default</instanceTenancy>\n <isDefault>false</isDefault>\n <tagSet/>\n </item>\n </vpcSet>\n</DescribeVpcsResponse>\n \n \n Example 2\n This example uses filters to describe any VPC you own that uses\n\t\t\t\t\tthe set of DHCP options with the ID dopt-7a8b9c2d or \n\t\t\t\t\tdopt-2b2a3d3c and whose state is available.\n https://ec2.amazonaws.com/?Action=DescribeVpcs\t\t\t\t\t\n&Filter.1.Name=dhcp-options-id\n&Filter.1.Value.1=dopt-7a8b9c2d\n&Filter.1.Value.2=dopt-2b2a3d3c\n&Filter.2.Name=state\n&Filter.2.Value.1=available\n&AUTHPARAMS\n \n \n " + }, + "DescribeVpnConnections": { + "name": "DescribeVpnConnections", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpnConnectionIds": { + "type": "list", + "documentation": "\n\t\t

One or more VPN connection IDs.

\n\t\t

Default: Describes your VPN connections.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "VpnConnectionId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpnConnections": { + "type": "list", + "documentation": "\n\t\t

Information about one or more VPN connections.

\n ", + "locationName": "vpnConnectionSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a VPN connection.

\n ", + "locationName": "item", + "members": { + "VpnConnectionId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPN connection.

\n ", + "locationName": "vpnConnectionId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\t

The current state of the VPN connection.

\n ", + "locationName": "state" + }, + "CustomerGatewayConfiguration": { + "type": "string", + "documentation": "\n\t\t

The configuration information for the VPN connection's customer gateway (in the\n\t\t\t\tnative XML format). This element is always present in the\n\t\t\t\tCreateVpnConnection response; however, it's present in the\n\t\t\t\tDescribeVpnConnections response only if the VPN connection is in\n\t\t\t\tthe pending or available state.

\n ", + "locationName": "customerGatewayConfiguration" + }, + "Type": { + "type": "string", + "enum": [ + "ipsec.1" + ], + "documentation": "\n\t\t

The type of VPN connection.

\n ", + "locationName": "type" + }, + "CustomerGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the customer gateway at your end of the VPN connection.

\n ", + "locationName": "customerGatewayId" + }, + "VpnGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway at the AWS side of the VPN connection.

\n ", + "locationName": "vpnGatewayId" + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the VPN connection.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "VgwTelemetry": { + "type": "list", + "documentation": "\n\t\t

Information about the VPN tunnel.

\n ", + "locationName": "vgwTelemetry", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes telemetry for a VPN tunnel.

\n ", + "locationName": "item", + "members": { + "OutsideIpAddress": { + "type": "string", + "documentation": "\n\t\t

The Internet-routable IP address of the virtual private gateway's outside interface.

\n ", + "locationName": "outsideIpAddress" + }, + "Status": { + "type": "string", + "enum": [ + "UP", + "DOWN" + ], + "documentation": "\n\t\t

The status of the VPN tunnel.

\n ", + "locationName": "status" + }, + "LastStatusChange": { + "type": "timestamp", + "documentation": "\n\t\t

The date and time of the last change in status.

\n ", + "locationName": "lastStatusChange" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n\t\t

If an error occurs, a description of the error.

\n ", + "locationName": "statusMessage" + }, + "AcceptedRouteCount": { + "type": "integer", + "documentation": "\n\t\t

The number of accepted routes.

\n ", + "locationName": "acceptedRouteCount" + } + } + } + }, + "Options": { + "type": "structure", + "documentation": "\n\t\t

The VPN connection options.

\n ", + "locationName": "options", + "members": { + "StaticRoutesOnly": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.

\n ", + "locationName": "staticRoutesOnly" + } + } + }, + "Routes": { + "type": "list", + "documentation": "\n\t\t

The static routes associated with the VPN connection.

\n ", + "locationName": "routes", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a static route for a VPN connection.

\n ", + "locationName": "item", + "members": { + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR block associated with the local subnet of the customer data center.

\n ", + "locationName": "destinationCidrBlock" + }, + "Source": { + "type": "string", + "enum": [ + "Static" + ], + "documentation": "\n\t\t

Indicates how the routes were provided.

\n ", + "locationName": "source" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\t

The current state of the static route.

\n ", + "locationName": "state" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your VPN connections.

\n\t\t

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example describes the specified VPN connection. The response\n\t\t\t\t\tincludes the customer gateway configuration information. Because it's a long set\n\t\t\t\t\tof information, we haven't displayed it here. To see an example of the configuration information,\n\t\t\t\t see the Amazon Virtual Private Cloud Network Administrator Guide.\n https://ec2.amazonaws.com/?Action=DescribeVpnConnections\n&VpnConnectionId.1=vpn-44a8938f\n&AUTHPARAMS\n <DescribeVpnConnectionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpnConnectionSet>\n <item>\n <vpnConnectionId>vpn-44a8938f</vpnConnectionId>\n <state>available</state>\n <customerGatewayConfiguration>\n ...Customer gateway configuration data in escaped XML format...\n </customerGatewayConfiguration> \n <type>ipsec.1</type>\n <customerGatewayId>cgw-b4dc3961</customerGatewayId>\n <vpnGatewayId>vgw-8db04f81</vpnGatewayId>\n <tagSet/>\n </item>\n </vpnConnectionSet>\n</DescribeVpnConnectionsResponse>\n \n \n Example 2\n This example describes any VPN connection you own that is associated with the\n\t\t\t\t\tcustomer gateway with ID cgw-b4dc3961, and whose state is either\n\t\t\t\t\tpending or available.\n https://ec2.amazonaws.com/?Action=DescribeVpnConnections\t\t\t\t\t\t\t\n&Filter.1.Name=customer-gateway-id\n&Filter.1.Value.1=cgw-b4dc3961\n&Filter.2.Name=state\n&Filter.2.Value.1=pending\n&Filter.2.Value.2=available\n&AUTHPARAMS\n \n \n " + }, + "DescribeVpnGateways": { + "name": "DescribeVpnGateways", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpnGatewayIds": { + "type": "list", + "documentation": "\n\t\t

One or more virtual private gateway IDs.

\n\t\t

Default: Describes all your virtual private gateways.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "VpnGatewayId" + } + }, + "Filters": { + "type": "list", + "documentation": "\n\t\t

One or more filters.

\n\t\t \n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "locationName": "Filter", + "members": { + "Name": { + "type": "string", + "documentation": "\n

The name of the filter.

\n " + }, + "Values": { + "type": "list", + "documentation": "\n

One or more filter values.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "Value" + } + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "VpnGateways": { + "type": "list", + "documentation": "\n\t\t

Information about one or more virtual private gateways.

\n ", + "locationName": "vpnGatewaySet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a virtual private gateway.

\n ", + "locationName": "item", + "members": { + "VpnGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway.

\n ", + "locationName": "vpnGatewayId" + }, + "State": { + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\t

The current state of the virtual private gateway.

\n ", + "locationName": "state" + }, + "Type": { + "type": "string", + "enum": [ + "ipsec.1" + ], + "documentation": "\n\t\t

The type of VPN connection the virtual private gateway supports.

\n ", + "locationName": "type" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n\t\t

The Availability Zone where the virtual private gateway was created.

\n ", + "locationName": "availabilityZone" + }, + "VpcAttachments": { + "type": "list", + "documentation": "\n\t\t

Any VPCs attached to the virtual private gateway.

\n ", + "locationName": "attachments", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an attachment between a virtual private gateway and a VPC.

\n ", + "locationName": "item", + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The current state of the attachment.

\n ", + "locationName": "state" + } + } + } + }, + "Tags": { + "type": "list", + "documentation": "\n\t\t

Any tags assigned to the virtual private gateway.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Describes one or more of your virtual private gateways.

\n\t\t

For more information about virtual private gateways, see Adding an IPsec Hardware VPN\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example 1\n This example describes the specified virtual private gateway.\n https://ec2.amazonaws.com/?Action=DescribeVpnGateways\n&VpnGatewayId.1=vgw-8db04f81\n&AUTHPARAMS\n <DescribeVpnGatewaysResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <vpnGatewaySet>\t\n <item>\n <vpnGatewayId>vgw-8db04f81</vpnGatewayId>\n <state>available</state>\n <type>ipsec.1</type>\n <availabilityZone>us-east-1a</availabilityZone> \n <attachments>\n <item>\n <vpcId>vpc-1a2b3c4d<vpcId>\n <state>attached</state>\n </item>\n </attachments>\n <tagSet/>\n </item>\n </vpnGatewaySet>\n</DescribeVpnGatewaysResponse>\n \n \n Example 2\n This example uses filters to describe any virtual private gateway you own\n\t\t\t\t\tthat is in the us-east-1a Availability Zone, and whose state is either\n\t\t\t\t\tpending or available.\n https://ec2.amazonaws.com/?Action=DescribeVpnGateways\n&Filter.1.Name=availability-zone\n&Filter.1.Value.1=us-east-1a\n&Filter.2.Name=state\n&Filter.2.Value.1=pending\n&Filter.2.Value.2=available\n&AUTHPARAMS\n \n \n " + }, + "DetachInternetGateway": { + "name": "DetachInternetGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InternetGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InternetGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the Internet gateway.

\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Detaches an Internet gateway from a VPC, disabling connectivity between the\n\t\t\t\tInternet and the VPC. The VPC must not contain any running instances with Elastic IP\n\t\t\t\taddresses.

\n \n \n Example\n The example detaches the specified Internet gateway from the specified VPC.\n https://ec2.amazonaws.com/?Action=DetachInternetGateway\n&InternetGatewayId=igw-eaad4883\n&VpcId=vpc-11ad4878\n&AUTHPARAMS\n <DetachInternetGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DetachInternetGatewayResponse>\n \n \n " + }, + "DetachNetworkInterface": { + "name": "DetachNetworkInterface", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "AttachmentId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "AttachmentId": { + "type": "string", + "documentation": "\n\t\t

The ID of the attachment.

\n " + }, + "Force": { + "type": "boolean", + "documentation": "\n\t\t

Specifies whether to force a detachment.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Detaches a network interface from an instance.

\n \n \n Example\n This example detaches the specified elastic network interface (ENI).\n https://ec2.amazonaws.com/?Action=DetachNetworkInterface\n&AttachmentId=eni-attach-d94b09b0\n&AUTHPARAMS\n <DetachNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>ce540707-0635-46bc-97da-33a8a362a0e8</requestId>\n <return>true</return>\n</DetachNetworkInterfaceResponse>\n \n \n " + }, + "DetachVolume": { + "name": "DetachVolume", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + }, + "Device": { + "type": "string", + "documentation": "\n

The device name.

\n " + }, + "Force": { + "type": "boolean", + "documentation": "\n

Forces detachment if the previous detachment attempt did not occur cleanly (for example,\n logging into an instance, unmounting the volume, and detaching normally). This option can lead\n to data loss or a corrupted file system. Use this option only as a last resort to detach a\n volume from a failed instance. The instance won't have an opportunity to flush file system\n caches or file system metadata. If you use this option, you must perform file system check and\n repair procedures.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "locationName": "attachment", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n ", + "locationName": "volumeId" + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "Device": { + "type": "string", + "documentation": "\n

The device name.

\n ", + "locationName": "device" + }, + "State": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n

The attachment state of the volume.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so results in\n the volume being stuck in a busy state while detaching.

\n

If an Amazon EBS volume is the root device of an instance, it can't be detached while the\n instance is running. To detach the root volume, stop the instance\n first.

\n

If the root volume is detached from an instance with an AWS Marketplace product code, then\n the AWS Marketplace product codes from that volume are no longer associated with the\n instance.

\n

For more information, see Detaching an\n Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example detaches volume\n vol-1a2b3c4d.\n https://ec2.amazonaws.com/?Action=DetachVolume\n&VolumeId=vol-1a2b3c4d\n&AUTHPARAMS\n <DetachVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <volumeId>vol-1a2b3c4d</volumeId>\n <instanceId>i-1a2b3c4d</instanceId>\n <device>/dev/sdh</device>\n <status>detaching</status>\n <attachTime>YYYY-MM-DDTHH:MM:SS.000Z</attachTime>\n</DetachVolumeResponse>\n \n \n " + }, + "DetachVpnGateway": { + "name": "DetachVpnGateway", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpnGatewayId", + "VpcId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpnGatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway.

\n " + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the\n\t\t\t\tVPC and not use it anymore. You can confirm a virtual private gateway has been completely\n\t\t\t\tdetached from a VPC by describing the virtual private gateway (any attachments to the\n\t\t\t\tvirtual private gateway are also described).

\n\t\t

You must wait for the attachment's state to switch to detached before\n\t\t\t\tyou can delete the VPC or attach a different VPC to the virtual private gateway.

\n \n \n Example\n This example detaches the specified virtual private gateway from the specified VPC.\n https://ec2.amazonaws.com/?Action=DetachVpnGateway\n&VpnGatewayId=vgw-8db04f81\n&VpcId=vpc-1a2b3c4d\n&AUTHPARAMS\n <DetachVpnGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</DetachVpnGatewayResponse>\n \n \n " + }, + "DisableVgwRoutePropagation": { + "name": "DisableVgwRoutePropagation", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "RouteTableId", + "GatewayId" + ], + "members": { + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the routing table.

\n " + }, + "GatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Disables a virtual private gateway (VGW) from propagating routes to the routing\n\t\t\t\ttables of a VPC.

\n \n \n Example\n This example disables the virtual private gateway vgw-d8e09e8a\n\t\t\t\t\tfrom automatically propagating routes to the routing table with ID\n\t\t\t\t\trtb-c98a35a0.\n https://ec2.amazonaws.com/?Action=DisableVgwRoutePropagationResponse\n&RouteTableID=rtb-c98a35a0\n&GatewayId= vgw-d8e09e8a\n&AUTHPARAMS\n <DisableVgwRoutePropagationResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>4f35a1b2-c2c3-4093-b51f-abb9d7311990</requestId>\n <return>true</return>\n</DisableVgwRoutePropagationResponse>\n \n \n " + }, + "DisassociateAddress": { + "name": "DisassociateAddress", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "PublicIp": { + "type": "string", + "documentation": "\n

[EC2-Classic] The Elastic IP address.

\n " + }, + "AssociationId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The association ID.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Disassociates an Elastic IP address from the instance or network interface it's\n\t\t\t\tassociated with.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n\t\t\t\tdoesn't return an error.

\n \n \n Example for EC2-Classic\n This example disassociates the specified Elastic IP address from\n\t\t\t\t\tthe instance in EC2-Classic to which it is associated.\n https://ec2.amazonaws.com/?Action=DisassociateAddress\n&PublicIp=192.0.2.1\n&AUTHPARAMS\n \n \n Example for EC2-VPC\n This example disassociates the specified Elastic IP address from\n\t\t\t\t\t the instance in a VPC to which it is associated.\n https://ec2.amazonaws.com/?Action=DisassociateAddress\n&AssociationId=eipassoc-aa7486c3\n&AUTHPARAMS\n \n \n " + }, + "DisassociateRouteTable": { + "name": "DisassociateRouteTable", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "AssociationId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "AssociationId": { + "type": "string", + "documentation": "\n\t\t

The association ID representing the current association between the route table and subnet.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Disassociates a subnet from a route table.

\n\t\t

After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\tTables in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example disassociates the specified route table from the subnet it's associated to.\n https://ec2.amazonaws.com/?Action=DisassociateRouteTable\n&AssociationId=rtbassoc-fdad4894\n&AUTHPARAMS\n <DisassociateRouteTableResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DisassociateRouteTableResponse>\n \n \n " + }, + "EnableVgwRoutePropagation": { + "name": "EnableVgwRoutePropagation", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "RouteTableId", + "GatewayId" + ], + "members": { + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the routing table.

\n " + }, + "GatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of the virtual private gateway.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Enables a virtual private gateway (VGW) to propagate routes to the routing tables\n\t\t\t\tof a VPC.

\n \n \n Example\n This example enables the specified virtual private gateway to propagate\n\t\t\t\t\troutes automatically to the routing table with the ID rtb-c98a35a0.\n https://ec2.amazonaws.com/?Action=EnableVgwRoutePropagation\n&RouteTableID=rtb-c98a35a0\n&GatewayId= vgw-d8e09e8a\n&AUTHPARAMS\n <EnableVgwRoutePropagation xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>4f35a1b2-c2c3-4093-b51f-abb9d7311990</requestId>\n <return>true</return>\n</EnableVgwRoutePropagation>\n \n \n " + }, + "EnableVolumeIO": { + "name": "EnableVolumeIO", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Enables I/O operations for a volume that had I/O operations disabled because the data on the\n volume was potentially inconsistent.

\n \n \n Example\n This example enables the I/O operations of the volume\n vol-8888888.\n https://ec2.amazonaws.com/?Action=EnableVolumeIO\n&VolumeId= vol-8888888\n&AUTHPARAMS\n <EnableVolumeIOResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</EnableVolumeIOResponse>\n \n \n " + }, + "GetConsoleOutput": { + "name": "GetConsoleOutput", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "Timestamp": { + "type": "timestamp", + "documentation": "\n

The time the output was last updated.

\n ", + "locationName": "timestamp" + }, + "Output": { + "type": "string", + "documentation": "\n

The console output, Base64 encoded.

\n ", + "locationName": "output" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Gets the console output for the specified instance.

\n

Instances do not have a physical monitor through which you can view their\n console output. They also lack physical controls that allow you to power up, reboot,\n or shut them down. To allow these actions, we provide them through the Amazon EC2\n API and command line interface.

\n\t\t\t

Instance console output is buffered and posted shortly after instance boot,\n\t\t\t\treboot, and termination. Amazon EC2 preserves the most recent 64 KB output which\n\t\t\t\tis available for at least one hour after the most recent post.

\n\t\t\t

For Linux/Unix instances, the instance console output displays the\n\t\t\t\texact console output that would normally be displayed on a physical monitor attached\n\t\t\t\tto a machine. This output is buffered because the instance produces it and then\n\t\t\t\tposts it to a store where the instance's owner can retrieve it.

\n\t\t\t

For Windows instances, the instance console output displays the last\n\t\t\t\tthree system event log errors.

\n \n \n Example\n This example retrieves the console output for the specified instance.\n https://ec2.amazonaws.com/?Action=GetConsoleOutput\n&InstanceId=i-10a64379\n&AUTHPARAMS\n <GetConsoleOutputResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instanceId>i-28a64341</instanceId>\n <timestamp>2010-10-14T01:12:41.000Z</timestamp>\n <output>TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hbWF6b25zYSkgKGdj\nYyB2ZXJzaW9uIDQuMC4xIDIwMDUwNzI3IChSZWQgSGF0IDQuMC4xLTUpKSAjMSBTTVAgVGh1IE9j\ndCAyNiAwODo0MToyNiBTQVNUIDIwMDYKQklPUy1wcm92aWRlZCBwaHlzaWNhbCBSQU0gbWFwOgpY\nZW46IDAwMDAwMDAwMDAwMDAwMDAgLSAwMDAwMDAwMDZhNDAwMDAwICh1c2FibGUpCjk4ME1CIEhJ\nR0hNRU0gYXZhaWxhYmxlLgo3MjdNQiBMT1dNRU0gYXZhaWxhYmxlLgpOWCAoRXhlY3V0ZSBEaXNh\nYmxlKSBwcm90ZWN0aW9uOiBhY3RpdmUKSVJRIGxvY2t1cCBkZXRlY3Rpb24gZGlzYWJsZWQKQnVp\nbHQgMSB6b25lbGlzdHMKS2VybmVsIGNvbW1hbmQgbGluZTogcm9vdD0vZGV2L3NkYTEgcm8gNApF\nbmFibGluZyBmYXN0IEZQVSBzYXZlIGFuZCByZXN0b3JlLi4uIGRvbmUuCg==</output>\n</GetConsoleOutputResponse>\n \n \n " + }, + "GetPasswordData": { + "name": "GetPasswordData", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the Windows instance.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the Windows instance.

\n ", + "locationName": "instanceId" + }, + "Timestamp": { + "type": "timestamp", + "documentation": "\n

The time the data was last updated.

\n ", + "locationName": "timestamp" + }, + "PasswordData": { + "type": "string", + "documentation": "\n

The password of the instance.

\n ", + "locationName": "passwordData" + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t\t

Retrieves the encrypted administrator password for an instance running\n\t\t\t\tWindows.

\n\t\t\t

The Windows password is only generated the first time an AMI is launched.\n\t\t\t\tIt is not generated for rebundled AMIs or after the password is changed on an\n\t\t\t\tinstance.

\n\t\t\t

The password is encrypted using the key pair that you specified when you launched the instance.\n\t\t\t\tYou must provide the corresponding key pair file.

\n\t\t\t

Password generation and encryption takes a few moments. We recommend that you wait up to\n\t\t\t\t15 minutes after launching an instance before trying to retrieve the generated\n\t\t\t\tpassword.

\n \n \n Example\n This example returns the encrypted version of the administrator password for\n\t\t\t\t\tthe specified instance.\n https://ec2.amazonaws.com/?Action=GetPasswordData\n&InstanceId=i-10a64379\n&AUTHPARAMS\n <GetPasswordDataResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instanceId>i-2574e22a</instanceId>\n <timestamp>2009-10-24 15:00:00</timestamp>\n <passwordData>TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hbWF6b25zYSkgKGdj</passwordData>\n</GetPasswordDataResponse>\n \n \n " + }, + "ImportInstance": { + "name": "ImportInstance", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Platform" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Description": { + "type": "string", + "documentation": "\n

A description for the instance being imported.

\n " + }, + "LaunchSpecification": { + "type": "structure", + "documentation": "\n

\n ", + "members": { + "Architecture": { + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\n

The architecture of the instance.

\n " + }, + "GroupNames": { + "type": "list", + "documentation": "\n

One or more security group names.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "GroupName" + } + }, + "AdditionalInfo": { + "type": "string", + "documentation": "\n " + }, + "UserData": { + "type": "string", + "documentation": "\n

User data to be made available to the instance.

\n " + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

\n " + }, + "Placement": { + "type": "structure", + "documentation": "\n ", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone of the instance.

\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The name of the placement group the instance is in (for cluster compute instances).

\n " + }, + "Tenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n

The tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.

\n " + } + } + }, + "Monitoring": { + "type": "boolean", + "documentation": "\n " + }, + "SubnetId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The ID of the subnet to launch the instance\n into.

\n " + }, + "InstanceInitiatedShutdownBehavior": { + "type": "string", + "enum": [ + "stop", + "terminate" + ], + "documentation": "\n

Indicates whether an instance stops or terminates when you initiate\n shutdown from the instance (using the operating system command for system shutdown).

\n " + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n

[EC2-VPC] Optionally, you can use this parameter to assign the\n instance a specific available IP address from the IP address range of\n the subnet.

\n " + } + } + }, + "DiskImages": { + "type": "list", + "documentation": "\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a disk image.

\n ", + "locationName": "DiskImage", + "members": { + "Image": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members": { + "Format": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The disk image format.

\n " + }, + "Bytes": { + "type": "long", + "documentation": "\n " + }, + "ImportManifestUrl": { + "type": "string", + "documentation": "\n

A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.

\n " + } + } + }, + "Description": { + "type": "string", + "documentation": "\n " + }, + "Volume": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Size" + ], + "members": { + "Size": { + "type": "long", + "documentation": "\n

The size of the volume, in GiB.

\n " + } + } + } + } + } + }, + "Platform": { + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\n

The instance operating system.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ConversionTask": { + "type": "structure", + "documentation": "\n ", + "locationName": "conversionTask", + "required": [ + "ConversionTaskId", + "State" + ], + "members": { + "ConversionTaskId": { + "type": "string", + "documentation": "\n

The ID of the conversion task.

\n ", + "locationName": "conversionTaskId" + }, + "ExpirationTime": { + "type": "string", + "documentation": "\n

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

\n ", + "locationName": "expirationTime" + }, + "ImportInstance": { + "type": "structure", + "documentation": "\n

If the task is for importing an instance, this contains information about the import instance task.

\n ", + "locationName": "importInstance", + "required": [ + "Volumes" + ], + "members": { + "Volumes": { + "type": "list", + "documentation": "\n ", + "locationName": "volumes", + "member": { + "type": "structure", + "documentation": "\n

Describes an import volume task.

\n ", + "locationName": "item", + "required": [ + "BytesConverted", + "AvailabilityZone", + "Status" + ], + "members": { + "BytesConverted": { + "type": "long", + "documentation": "\n

The number of bytes converted so far.

\n ", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone where the resulting instance will reside.

\n ", + "locationName": "availabilityZone" + }, + "Image": { + "type": "structure", + "documentation": "\n

The image.

\n ", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The disk image format.

\n ", + "locationName": "format" + }, + "Size": { + "type": "long", + "documentation": "\n

The size of the disk image.

\n ", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "documentation": "\n

A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.

\n ", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "documentation": "\n

The checksum computed for the disk image.

\n ", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "documentation": "\n

The volume.

\n ", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "documentation": "\n

The size of the volume.

\n ", + "locationName": "size" + }, + "Id": { + "type": "string", + "documentation": "\n

The volume identifier.

\n ", + "locationName": "id" + } + } + }, + "Status": { + "type": "string", + "documentation": "\n

The status of the import of this particular disk image.

\n ", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The status information or errors related to the disk image.

\n ", + "locationName": "statusMessage" + }, + "Description": { + "type": "string", + "documentation": "\n ", + "locationName": "description" + } + } + } + }, + "InstanceId": { + "type": "string", + "documentation": "\n ", + "locationName": "instanceId" + }, + "Platform": { + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\n

The instance operating system.

\n ", + "locationName": "platform" + }, + "Description": { + "type": "string", + "documentation": "\n ", + "locationName": "description" + } + } + }, + "ImportVolume": { + "type": "structure", + "documentation": "\n

If the task is for importing a volume, this contains information about the import volume task.

\n ", + "locationName": "importVolume", + "required": [ + "BytesConverted", + "AvailabilityZone" + ], + "members": { + "BytesConverted": { + "type": "long", + "documentation": "\n

The number of bytes converted so far.

\n ", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone where the resulting volume will reside.

\n ", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "documentation": "\n

The description you provided when starting the import volume task.

\n ", + "locationName": "description" + }, + "Image": { + "type": "structure", + "documentation": "\n

The image.

\n ", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The disk image format.

\n ", + "locationName": "format" + }, + "Size": { + "type": "long", + "documentation": "\n

The size of the disk image.

\n ", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "documentation": "\n

A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.

\n ", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "documentation": "\n

The checksum computed for the disk image.

\n ", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "documentation": "\n

The volume.

\n ", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "documentation": "\n

The size of the volume.

\n ", + "locationName": "size" + }, + "Id": { + "type": "string", + "documentation": "\n

The volume identifier.

\n ", + "locationName": "id" + } + } + } + } + }, + "State": { + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\n

The state of the conversion task.

\n ", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The status message related to the conversion task.

\n ", + "locationName": "statusMessage" + }, + "Tags": { + "type": "list", + "documentation": "\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates an import instance task using metadata from the specified disk image. After\n importing the image, you then upload it using the ec2-import-volume command in the EC2 command line\n tools. For more information, see Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2 in the\n Amazon Elastic Compute Cloud User Guide.

\n \n \n \n \n Example\n This example creates an import instance task that migrates a Windows Server\n 2008 SP2 (32-bit) VM into the AWS us-east-1 region. \n https://ec2.amazonaws.com/?Action=ImportInstance\n &LaunchSpecification.Architecture=x86_64\n &LaunchSpecification.InstanceType=m1.xlarge\n &DiskImage.1.Image.Format=VMDK\n &DiskImage.1.Image.Bytes=1179593728\n &DiskImage.1.Image.ImportManifestUrl=https://s3.amazonaws.com/myawsbucket/​a3a5e1b6-590d-43cc-97c1-15c7325d3f41/​Win_2008_Server_Data_Center_SP2_32-bit.​vmdkmanifest.xml?AWSAccessKeyId=​AKIAIOSFODNN7EXAMPLE&​Expires=1294855591&​Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n &DiskImage.1.Volume.Size=12\t\n &Platform=Windows\n &AUTHPARAMS\n \n \n import-i-ffvko9js\n 2010-12-22T12:01Z\n \n \n \n 0\n us-east-1a\n \n VMDK\n 1179593728\n \n https://s3.amazonaws.com/myawsbucket/​a3a5e1b6-590d-43cc-97c1-15c7325d3f41/​Win_2008_Server_Data_Center_SP2_32-bit.​vmdkmanifest.xml?AWSAccessKeyId=​AKIAIOSFODNN7EXAMPLE&​Expires=1294855591&​Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n \n \n \n \n 12\n vol-1a2b3c4d\n \n active\n \n \n \n i-12655a7f\n \n \n \n\n \n \n " + }, + "ImportKeyPair": { + "name": "ImportKeyPair", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "KeyName", + "PublicKeyMaterial" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "KeyName": { + "type": "string", + "documentation": "\n

A unique name for the key pair.

\n " + }, + "PublicKeyMaterial": { + "type": "blob", + "documentation": "\n

The public key. You must base64 encode the public key material before sending it to AWS.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "KeyName": { + "type": "string", + "documentation": "\n

The key pair name you provided.

\n ", + "locationName": "keyName" + }, + "KeyFingerprint": { + "type": "string", + "documentation": "\n

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

\n ", + "locationName": "keyFingerprint" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Imports the public key from an RSA key pair that you created with a third-party tool. \n Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you \n (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. \n The private key is never transferred between you and AWS.

\n

For more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example imports the public key named my-key-pair.\n https://ec2.amazonaws.com/?Action=ImportKeyPair\n&KeyName=my-key-pair\n&PublicKeyMaterial=MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6\nb24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd\nBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN\nMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD\nVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z\nb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt\nYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ\n21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T\nrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE\nIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4\nnUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb\nFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb\nNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE\n&AUTHPARAMS\n <ImportKeyPairResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n\t<keyName>my-key-pair</keyName>\n\t<keyFingerprint>1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f</keyFingerprint>\n</ImportKeyPairResponse>\n \n \n " + }, + "ImportVolume": { + "name": "ImportVolume", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "AvailabilityZone" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone for the resulting Amazon EBS\n volume.

\n " + }, + "Image": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members": { + "Format": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The disk image format.

\n " + }, + "Bytes": { + "type": "long", + "documentation": "\n " + }, + "ImportManifestUrl": { + "type": "string", + "documentation": "\n

A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.

\n " + } + } + }, + "Description": { + "type": "string", + "documentation": "\n

An optional description for the volume being imported.

\n " + }, + "Volume": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Size" + ], + "members": { + "Size": { + "type": "long", + "documentation": "\n

The size of the volume, in GiB.

\n " + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ConversionTask": { + "type": "structure", + "documentation": "\n ", + "locationName": "conversionTask", + "required": [ + "ConversionTaskId", + "State" + ], + "members": { + "ConversionTaskId": { + "type": "string", + "documentation": "\n

The ID of the conversion task.

\n ", + "locationName": "conversionTaskId" + }, + "ExpirationTime": { + "type": "string", + "documentation": "\n

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

\n ", + "locationName": "expirationTime" + }, + "ImportInstance": { + "type": "structure", + "documentation": "\n

If the task is for importing an instance, this contains information about the import instance task.

\n ", + "locationName": "importInstance", + "required": [ + "Volumes" + ], + "members": { + "Volumes": { + "type": "list", + "documentation": "\n ", + "locationName": "volumes", + "member": { + "type": "structure", + "documentation": "\n

Describes an import volume task.

\n ", + "locationName": "item", + "required": [ + "BytesConverted", + "AvailabilityZone", + "Status" + ], + "members": { + "BytesConverted": { + "type": "long", + "documentation": "\n

The number of bytes converted so far.

\n ", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone where the resulting instance will reside.

\n ", + "locationName": "availabilityZone" + }, + "Image": { + "type": "structure", + "documentation": "\n

The image.

\n ", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The disk image format.

\n ", + "locationName": "format" + }, + "Size": { + "type": "long", + "documentation": "\n

The size of the disk image.

\n ", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "documentation": "\n

A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.

\n ", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "documentation": "\n

The checksum computed for the disk image.

\n ", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "documentation": "\n

The volume.

\n ", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "documentation": "\n

The size of the volume.

\n ", + "locationName": "size" + }, + "Id": { + "type": "string", + "documentation": "\n

The volume identifier.

\n ", + "locationName": "id" + } + } + }, + "Status": { + "type": "string", + "documentation": "\n

The status of the import of this particular disk image.

\n ", + "locationName": "status" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The status information or errors related to the disk image.

\n ", + "locationName": "statusMessage" + }, + "Description": { + "type": "string", + "documentation": "\n ", + "locationName": "description" + } + } + } + }, + "InstanceId": { + "type": "string", + "documentation": "\n ", + "locationName": "instanceId" + }, + "Platform": { + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\n

The instance operating system.

\n ", + "locationName": "platform" + }, + "Description": { + "type": "string", + "documentation": "\n ", + "locationName": "description" + } + } + }, + "ImportVolume": { + "type": "structure", + "documentation": "\n

If the task is for importing a volume, this contains information about the import volume task.

\n ", + "locationName": "importVolume", + "required": [ + "BytesConverted", + "AvailabilityZone" + ], + "members": { + "BytesConverted": { + "type": "long", + "documentation": "\n

The number of bytes converted so far.

\n ", + "locationName": "bytesConverted" + }, + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone where the resulting volume will reside.

\n ", + "locationName": "availabilityZone" + }, + "Description": { + "type": "string", + "documentation": "\n

The description you provided when starting the import volume task.

\n ", + "locationName": "description" + }, + "Image": { + "type": "structure", + "documentation": "\n

The image.

\n ", + "required": [ + "Format", + "Size", + "ImportManifestUrl" + ], + "locationName": "image", + "members": { + "Format": { + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n

The disk image format.

\n ", + "locationName": "format" + }, + "Size": { + "type": "long", + "documentation": "\n

The size of the disk image.

\n ", + "locationName": "size" + }, + "ImportManifestUrl": { + "type": "string", + "documentation": "\n

A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.

\n ", + "locationName": "importManifestUrl" + }, + "Checksum": { + "type": "string", + "documentation": "\n

The checksum computed for the disk image.

\n ", + "locationName": "checksum" + } + } + }, + "Volume": { + "type": "structure", + "documentation": "\n

The volume.

\n ", + "required": [ + "Id" + ], + "locationName": "volume", + "members": { + "Size": { + "type": "long", + "documentation": "\n

The size of the volume.

\n ", + "locationName": "size" + }, + "Id": { + "type": "string", + "documentation": "\n

The volume identifier.

\n ", + "locationName": "id" + } + } + } + } + }, + "State": { + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\n

The state of the conversion task.

\n ", + "locationName": "state" + }, + "StatusMessage": { + "type": "string", + "documentation": "\n

The status message related to the conversion task.

\n ", + "locationName": "statusMessage" + }, + "Tags": { + "type": "list", + "documentation": "\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates an import volume task using metadata from the specified disk image.\n After importing the image, you then upload it using the\n ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. \n For more information, see Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2 in the\n Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example creates an import volume task that migrates a Windows Server 2008\n SP2 (32-bit) volume into the AWS us-east-1 region. \n https://ec2.amazonaws.com/?Action=ImportVolume\n &AvailabilityZone=us-east-1c\n &Image.Format=VMDK\n &Image.Bytes=128696320\n &Image.ImportManifestUrl=https://s3.amazonaws.com/myawsbucket/​a3a5e1b6-590d-43cc-97c1-15c7325d3f41/​Win_2008_Server_Data_Center_SP2_32-bit.​vmdkmanifest.xml?AWSAccessKeyId=​AKIAIOSFODNN7EXAMPLE&​Expires=1294855591&​Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n &VolumeSize=8\n &AUTHPARAMS>\n \n \n import-i-fh95npoc\n 2010-12-22T12:01Z\n \n 0\n us-east-1c\n \n \n VDMK\n 128696320\n \n https://s3.amazonaws.com/myawsbucket/​a3a5e1b6-590d-43cc-97c1-15c7325d3f41/​Win_2008_Server_Data_Center_SP2_32-bit.​vmdkmanifest.xml?AWSAccessKeyId=​AKIAIOSFODNN7EXAMPLE&​Expires=1294855591&​Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n \n ccb1b0536a4a70e86016b85229b5c6b10b14a4eb\n \n \n 8\n vol-34d8a2ff\n \n \n active\n \n \n\n \n \n " + }, + "ModifyImageAttribute": { + "name": "ModifyImageAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ImageId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n " + }, + "Attribute": { + "type": "string", + "documentation": "\n

The name of the attribute to modify.

\n " + }, + "OperationType": { + "type": "string", + "documentation": "\n

The operation type.

\n " + }, + "UserIds": { + "type": "list", + "documentation": "\n

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "UserId" + } + }, + "UserGroups": { + "type": "list", + "documentation": "\n

One or more user groups. This is only valid when modifying the launchPermission attribute.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "UserGroup" + } + }, + "ProductCodes": { + "type": "list", + "documentation": "\n

One or more product codes. After you add a product code to an AMI, it can't be removed.\n This is only valid when modifying the productCodes attribute.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ProductCode" + } + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the attribute being modified. This is only valid when modifying the description attribute.

\n " + }, + "LaunchPermission": { + "type": "structure", + "documentation": "\n

\n ", + "members": { + "Add": { + "type": "list", + "documentation": "\n

The AWS account ID to add to the list of launch permissions for the AMI.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a launch permission.

\n ", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The AWS account ID.

\n " + }, + "Group": { + "type": "string", + "enum": [ + "all" + ], + "documentation": "\n

The name of the group.

\n " + } + } + } + }, + "Remove": { + "type": "list", + "documentation": "\n

The AWS account ID to remove from the list of launch permissions for the AMI.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a launch permission.

\n ", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The AWS account ID.

\n " + }, + "Group": { + "type": "string", + "enum": [ + "all" + ], + "documentation": "\n

The name of the group.

\n " + } + } + } + } + } + }, + "Description": { + "type": "structure", + "documentation": "\n

A description for the AMI.

\n ", + "members": { + "Value": { + "type": "string", + "documentation": " \n " + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": " \n

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

\n

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

\n \n \n Example\n \n \n \n \n \n " + }, + "ModifyInstanceAttribute": { + "name": "ModifyInstanceAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ], + "documentation": "\n

The name of the attribute.

\n " + }, + "Value": { + "type": "string", + "documentation": "\n

A new value for the attribute. Use only with the kernel, ramdisk,\n userData, disableApiTermination, or\n intanceInitiateShutdownBehavior attribute.

\n " + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n\t\t\t

Modifies the DeleteOnTermination attribute for volumes\n\t\t\t\tthat are currently attached. The volume must be owned by the caller. If\n\t\t\t\tno value is specified for DeleteOnTermination, the default\n\t\t\t\tis true and the volume is deleted when the instance is\n\t\t\t\tterminated.

\n\t\t\t

To add instance store volumes to an Amazon EBS-backed instance,\n\t\t\t\tyou must add them when you launch the instance. For more\n\t\t\t\tinformation, see Updating the Block Device Mapping when Launching an Instance\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping entry.

\n ", + "locationName": "BlockDeviceMapping", + "members": { + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n " + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS volume.

\n " + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the volume is deleted on instance termination.

\n " + } + } + }, + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n " + }, + "NoDevice": { + "type": "string", + "documentation": "\n

suppress the specified device included in the block device mapping.

\n " + } + } + } + }, + "SourceDestCheck": { + "type": "structure", + "documentation": "\n

Specifies whether source/destination checking is enabled.\n\t\t\t\tA value of true means that checking is enabled, and\n\t\t\t\tfalse means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT.

\n ", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n " + } + } + }, + "DisableApiTermination": { + "type": "structure", + "documentation": "\n

Specifies whether to disable the ability to terminate the instance using the Amazon EC2 console, CLI, and API.

\n ", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n " + } + } + }, + "InstanceType": { + "type": "structure", + "documentation": "\n

Changes the instance type to the specified value. For more information, see\n\t\t\t\tInstance Types.\n\t\t\t\tIf the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

\n ", + "members": { + "Value": { + "type": "string", + "documentation": " \n " + } + } + }, + "Kernel": { + "type": "structure", + "documentation": "\n

Changes the instance's kernel to the specified value.

\n ", + "members": { + "Value": { + "type": "string", + "documentation": " \n " + } + } + }, + "Ramdisk": { + "type": "structure", + "documentation": "\n

Changes the instance's RAM disk to the specified value.

\n ", + "members": { + "Value": { + "type": "string", + "documentation": " \n " + } + } + }, + "UserData": { + "type": "structure", + "documentation": "\n

Changes the instance's user data to the specified value.

\n ", + "members": { + "Value": { + "type": "blob", + "documentation": " \n " + } + } + }, + "InstanceInitiatedShutdownBehavior": { + "type": "structure", + "documentation": "\n

Specifies whether an instance stops or terminates when you initiate\n\t\t\t\tshutdown from the instance (using the operating system command for system shutdown).

\n ", + "members": { + "Value": { + "type": "string", + "documentation": " \n " + } + } + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t\t

[EC2-VPC] Changes the security groups of the instance. You must specify\n\t\t\t\tat least one security group, even if it's just the default security\n\t\t\t\tgroup for the VPC. You must specify the security group ID, not the\n\t\t\t\tsecurity group name.

\n\t\t\t

For example, if you want the instance to be in sg-1a1a1a1a and\n\t\t\t\tsg-9b9b9b9b, specify GroupId.1=sg-1a1a1a1a and\n\t\t\t\tGroupId.2=sg-9b9b9b9b.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "GroupId" + } + }, + "EbsOptimized": { + "type": "structure", + "documentation": "\n

Specifies whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.

\n ", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n " + } + } + }, + "SriovNetSupport": { + "type": "structure", + "documentation": "\n

Set to simple to enable enhanced networking for the instance.

\n

There is no way to disable enhanced networking at this time.

\n

This option is supported only for HVM instances. Specifying this option\n with a PV instance can make it unreachable.

\n ", + "members": { + "Value": { + "type": "string", + "documentation": " \n " + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t\t

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

\n\t\t\t

To modify some attributes, the instance must be stopped. For more information, see\n\t\t\t\tModifying Attributes of a Stopped Instance\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example 1\n This example changes the instance type of the specified instance. The instance must be in the\n\t\t\t\t\tstopped state.\n https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute\n&InstanceId=i-10a64379\n&InstanceType.Value=m1.small\n&AUTHPARAMS\n <ModifyInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</ModifyInstanceAttributeResponse>\n \n \n Example 2\n This example changes the InstanceInitiatedShutdownBehavior attribute of the specified instance.\n https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute\n&InstanceId=i-10a64379\n&InstanceInitiatedShutdownBehavior.Value=terminate\n&AUTHPARAMS\n <ModifyInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</ModifyInstanceAttributeResponse>\n \n \n Example 3\n This example changes the DisableApiTermination attribute of the specified instance.\n https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute\n&InstanceId=i-10a64379\n&DisableApiTermination.Value=true\n&AUTHPARAMS\n <ModifyInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</ModifyInstanceAttributeResponse>\n \n \n " + }, + "ModifyNetworkInterfaceAttribute": { + "name": "ModifyNetworkInterfaceAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n " + }, + "Description": { + "type": "structure", + "documentation": "\n\t\t

A description for the network interface.

\n ", + "members": { + "Value": { + "type": "string", + "documentation": " \n " + } + } + }, + "SourceDestCheck": { + "type": "structure", + "documentation": "\n\t\t

Indicates whether source/destination checking is enabled.\n\t\t\t\tA value of true means checking\n\t\t\t\tis enabled, and false means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT. For more\n\t\t\t\tinformation, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.

\n ", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n " + } + } + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

Changes the security groups for the network interface. The new\n\t\t\t\tset of groups you specify replaces the current set. You must specify at\n\t\t\t\tleast one group, even if it's just the default security group in the\n\t\t\t\tVPC. You must specify the ID of the security group, not the name.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SecurityGroupId" + } + }, + "Attachment": { + "type": "structure", + "documentation": "\n\t\t

The ID of the interface attachment.

\n ", + "members": { + "AttachmentId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface attachment.

\n " + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the network interface is deleted when the instance is terminated.

\n " + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Modifies the specified network interface attribute. You can specify only one attribute at a time.

\n \n \n Example\n This example sets source/destination checking to false for the\n\t\t\t\t\tspecified network interface.\n https://ec2.amazonaws.com/?Action=ModifyNetworkInterfaceAttribute\n&NetworkInterfaceId=eni-ffda3197\n&SourceDestCheck.Value=false\n&AUTHPARAMS\n <ModifyNetworkInterfaceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>657a4623-5620-4232-b03b-427e852d71cf</requestId>\n <return>true</return>\n</ModifyNetworkInterfaceAttributeResponse>\n \n \n " + }, + "ModifyReservedInstances": { + "name": "ModifyReservedInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members": { + "ClientToken": { + "type": "string", + "documentation": "\n

A unique, case-sensitive token you provide to ensure idempotency of your modification request.

\n " + }, + "ReservedInstancesIds": { + "type": "list", + "documentation": "\n

The IDs of the Reserved Instances to modify.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "ReservedInstancesId" + } + }, + "TargetConfigurations": { + "type": "list", + "documentation": "\n

The configuration settings for the Reserved Instances to modify.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes the configuration settings for the modified Reserved Instances.

\n ", + "locationName": "ReservedInstancesConfigurationSetItemType", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone for the modified Reserved Instances.

\n " + }, + "Platform": { + "type": "string", + "documentation": "\n

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

\n " + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

The number of modified Reserved Instances.

\n " + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type for the modified Reserved Instances.

\n " + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesModificationId": { + "type": "string", + "documentation": "\n

The ID for the modification.

\n ", + "locationName": "reservedInstancesModificationId" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

\n \n \n Example\n https://ec2.amazonaws.com/?Action=ModifyReservedInstances\n&ClientToken=myClientToken\n&ReservedInstancesConfigurationSetItemType.0.AvailabilityZone=us-east-1a\n&ReservedInstancesConfigurationSetItemType.0.InstanceCount=1\n&ReservedInstancesConfigurationSetItemType.0.Platform=EC2-VPC\n&ReservedInstancesConfigurationSetItemType.0.InstanceType=m1.small\n&ReservedInstancesId.0=d16f7a91-4d0f-4f19-9d7f-a74d26b1ccfa\n&AUTHPARAMS\n bef729b6-0731-4489-8881-2258746ae163\nrimod-3aae219d-3d63-47a9-a7e9-e764example\n\n \n \n " + }, + "ModifySnapshotAttribute": { + "name": "ModifySnapshotAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SnapshotId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "productCodes", + "createVolumePermission" + ], + "documentation": "\n

The snapshot attribute to modify.

\n " + }, + "OperationType": { + "type": "string", + "documentation": "\n

The type of operation to perform to the attribute.

\n " + }, + "UserIds": { + "type": "list", + "documentation": "\n

The account ID to modify for the snapshot.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "UserId" + } + }, + "GroupNames": { + "type": "list", + "documentation": "\n

The group to modify for the snapshot.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "UserGroup" + } + }, + "CreateVolumePermission": { + "type": "structure", + "documentation": "\n

A JSON representation of the snapshot attribute modification.

\n ", + "members": { + "Add": { + "type": "list", + "documentation": "\n

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.

\n " + }, + "Group": { + "type": "string", + "enum": [ + "all" + ], + "documentation": "\n

The specific group that is to be added or removed from a volume's list of create volume\n permissions.

\n " + } + } + } + }, + "Remove": { + "type": "list", + "documentation": "\n

Removes a specific AWS account ID or group from a volume's list of create volume\n permissions.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n ", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.

\n " + }, + "Group": { + "type": "string", + "enum": [ + "all" + ], + "documentation": "\n

The specific group that is to be added or removed from a volume's list of create volume\n permissions.

\n " + } + } + } + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Adds or removes permission settings for the specified snapshot. You may add or remove\n specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single API call. If you need to both add and remove account IDs for a snapshot,\n you must use multiple API calls.

\n

For more information on modifying snapshot permissions, see Sharing Snapshots in the\n Amazon Elastic Compute Cloud User Guide.

\n \n

Snapshots with AWS Marketplace product codes cannot be made public.

\n \n \n \n Example\n This example makes the snap-1a2b3c4d snapshot public, and gives\n the account with ID 111122223333 permission to create volumes from\n the snapshot.\n https://ec2.amazonaws.com/?Action=ModifySnapshotAttribute\n&snapshotId=snap-1a2b3c4d\n&CreateVolumePermission.Add.1.UserId=111122223333\n&CreateVolumePermission.Add.1.Group=all\n&AUTHPARAMS\n <ModifySnapshotAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</ModifySnapshotAttributeResponse>\n \n \n Example\n This example makes the snap-1a2b3c4d snapshot public, and removes\n the account with ID 111122223333 from the list of users with\n permission to create volumes from the snapshot.\n https://ec2.amazonaws.com/?Action=ModifySnapshotAttribute\n&snapshotId=snap-1a2b3c4d\n&CreateVolumePermission.Remove.1.UserId=111122223333\n&CreateVolumePermission.Add.1.Group=all\n&AUTHPARAMS\n <ModifySnapshotAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</ModifySnapshotAttributeResponse>\n \n \n " + }, + "ModifySubnetAttribute": { + "name": "ModifySubnetAttribute", + "input": { + "type": "structure", + "documentation": "\n\t", + "required": [ + "SubnetId" + ], + "members": { + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n\t" + }, + "MapPublicIpOnLaunch": { + "type": "structure", + "documentation": " \n ", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n " + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Modifies a subnet attribute.

\n\t\t\n\t\t\t\n\t\t\t\tExample\n\t\t\t\tThis example modifies the attribute for subnet-1a2b3c4d to specify\n\t\t\t\t\tthat all instances launched into this subnet are assigned a public IP address. \n\t\t\t\thttps://ec2.amazonaws.com/?Action=ModifySubnetAttribute\n&SubnetId=subnet-1a2b3c4d\n&MapPublicIpOnLaunch.Value=true\n&AUTHPARAMS\n\t\t\t\n\t\t\n\t" + }, + "ModifyVolumeAttribute": { + "name": "ModifyVolumeAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VolumeId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the volume.

\n " + }, + "AutoEnableIO": { + "type": "structure", + "documentation": "\n

Indicates whether the volume should be auto-enabled for I/O operations.

\n ", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n " + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Modifies a volume attribute.

\n

By default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

\n

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes\n or for volumes that are stateless or disposable.

\n \n \n Example\n This example modifies the attribute of the volume vol-12345678.\n https://ec2.amazonaws.com/?Action=ModifyVolumeAttribute\n&VolumeId=vol-12345678\n&AutoEnableIO.Value=true\n&AUTHPARAMS\n <ModifyVolumeAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE</requestId> \n <return>true</return>\n</ModifyVolumeAttributeResponse>\n \n \n " + }, + "ModifyVpcAttribute": { + "name": "ModifyVpcAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpcId" + ], + "members": { + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n " + }, + "EnableDnsSupport": { + "type": "structure", + "documentation": "\n\t\t

Indicates whether the DNS resolution is supported for the VPC. If this attribute is\n false, the Amazon provided DNS service in the VPC that resolves public DNS\n hostnames to IP addresses is not enabled. If this attribute is true, queries to\n the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address\n at the base of the VPC network range \"plus two\" will succeed.

\n ", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n " + } + } + }, + "EnableDnsHostnames": { + "type": "structure", + "documentation": "\n\t\t

Indicates whether the instances launched in the VPC get DNS\n\t\t\t\thostnames. If this attribute is true, instances in the VPC\n\t\t\t\tget DNS hostnames; otherwise, they do not.

\n

You can only set enableDnsHostnames to true if you also\n\t\t\t\tset the EnableDnsSupport attribute to true.

\n ", + "members": { + "Value": { + "type": "boolean", + "documentation": " \n " + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Modifies the specified attribute of the specified VPC.

\n \n \n Example\n This example disables support for DNS hostnames in the specified VPC.\n https://ec2.amazonaws.com/?Action=ModifyVpcAttribute \n&VpcId=vpc-1a2b3c4d \n&EnableDnsHostnames.Value=false \n&AUTHPARAMS\n \n \n " + }, + "MonitorInstances": { + "name": "MonitorInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceIds": { + "type": "list", + "documentation": "\n

One or more instance IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "InstanceMonitorings": { + "type": "list", + "documentation": "\n

Monitoring information for one or more instances.

\n ", + "locationName": "instancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes the monitoring information of the instance.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "Monitoring": { + "type": "structure", + "documentation": "\n

The monitoring information.

\n ", + "locationName": "monitoring", + "members": { + "State": { + "type": "string", + "enum": [ + "disabled", + "enabled", + "pending" + ], + "documentation": "\n

Indicates whether monitoring is enabled for the instance.

\n ", + "locationName": "state" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Enables monitoring for a running instance. For more information about monitoring instances,\n\t\t\tsee Monitoring Your Instances and Volumes\n\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example enables monitoring for two instances.\n https://ec2.amazonaws.com/?Action=MonitorInstances\n&InstanceId.1=i-43a4412a\n&InstanceId.2=i-23a3397d\n&AUTHPARAMS\n <MonitorInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-43a4412a</instanceId>\n <monitoring>\n <state>pending</state>\n </monitoring>\n </item>\n <item>\n <instanceId>i-23a3397d</instanceId>\n <monitoring>\n <state>pending</state>\n </monitoring>\n </item>\n </instancesSet>\n</MonitorInstancesResponse>\n \n \n " + }, + "PurchaseReservedInstancesOffering": { + "name": "PurchaseReservedInstancesOffering", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ReservedInstancesOfferingId": { + "type": "string", + "documentation": "\n

The ID of the Reserved Instance offering to purchase.

\n " + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

The number of Reserved Instances to purchase.

\n " + }, + "LimitPrice": { + "type": "structure", + "documentation": "\n

Specified for Reserved Instance Marketplace offerings to limit the total order and\n\t\t\t\tensure that the Reserved Instances are not purchased at unexpected prices.

\n ", + "members": { + "Amount": { + "type": "double", + "documentation": "\n

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order\n\t\t\t\t(instanceCount * price).

\n " + }, + "CurrencyCode": { + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\n

The currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.

\n " + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ReservedInstancesId": { + "type": "string", + "documentation": "\n

The IDs of the purchased Reserved Instances.

\n ", + "locationName": "reservedInstancesId" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved\n\t\t\t\tInstances, you obtain a capacity reservation for a certain instance configuration\n\t\t\t\tover a specified period of time. You pay a lower usage rate than with On-Demand\n\t\t\t\tinstances for the time that you actually use the capacity reservation.

\n

For more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example 1\n This example uses a limit price to limit the total purchase order of \n Reserved Instances from Reserved Instance Marketplace.\n https://ec2.amazonaws.com/?Action=PurchaseReservedInstancesOffering\n&ReservedInstancesOfferingId=4b2293b4-5813-4cc8-9ce3-1957fEXAMPLE\n&LimitPrice.Amount=200\n&InstanceCount=2\n&AUTHPARAMS\n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE \n\n \n \n Example 2\n This example illustrates a purchase of a Reserved Instances offering.\n https://ec2.amazonaws.com/?Action=PurchaseReservedInstancesOffering\n&ReservedInstancesOfferingId=4b2293b4-5813-4cc8-9ce3-1957fEXAMPLE\n&InstanceCount=2\n&AUTHPARAMS\n <PurchaseReservedInstancesOfferingResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <reservedInstancesId>e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE</reservedInstancesId> \n</PurchaseReservedInstancesOfferingResponse>\n \n \n " + }, + "RebootInstances": { + "name": "RebootInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceIds": { + "type": "list", + "documentation": "\n

One or more instance IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t\t

Requests a reboot of one or more instances. This operation is asynchronous; it\n\t\t\t\tonly queues a request to reboot the specified instances. The operation\n\t\t\t\tsucceeds if the instances are valid and belong to you. Requests to reboot terminated\n\t\t\t\tinstances are ignored.

\n\t\t\t

If a Linux/Unix instance does not cleanly shut down within four minutes,\n\t\t\t\tAmazon EC2 performs a hard reboot.

\n

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the\n Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example reboots two instances.\n https://ec2.amazonaws.com/?Action=RebootInstances\n&InstanceId.1=i-1a2b3c4d\n&InstanceId.2=i-4d3acf62\n&AUTHPARAMS\n <RebootInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</RebootInstancesResponse>\n \n \n " + }, + "RegisterImage": { + "name": "RegisterImage", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Name" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ImageLocation": { + "type": "string", + "documentation": "\n

The full path to your AMI manifest in Amazon S3 storage.

\n " + }, + "Name": { + "type": "string", + "documentation": "\n

A name for your AMI.

\n

Constraints: 3-128 alphanumeric characters, parenthesis (()),\n\t\t\t\tcommas (,), slashes (/), dashes (-), or underscores (_)

\n " + }, + "Description": { + "type": "string", + "documentation": "\n

A description for your AMI.

\n " + }, + "Architecture": { + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\n

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

\n " + }, + "KernelId": { + "type": "string", + "documentation": "\n

The ID of the kernel.

\n " + }, + "RamdiskId": { + "type": "string", + "documentation": "\n

The ID of the RAM disk.

\n " + }, + "RootDeviceName": { + "type": "string", + "documentation": "\n

The name of the root device (for example, /dev/sda1, or\n\t\t\t\txvda).

\n " + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

One or more block device mapping entries.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "BlockDeviceMapping", + "members": { + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n " + }, + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n " + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n " + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

\n

Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.

\n " + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n " + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.

\n

Default: standard

\n " + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the\n volume supports.

\n

Constraint: Range is 100 to 4000.

\n

Condition: Required when the volume type is io1; not used with\n standard or gp2 volumes.

\n " + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is encrypted.

\n " + } + } + }, + "NoDevice": { + "type": "string", + "documentation": "\n

Suppresses the specified device included in the block device mapping of the AMI.

\n " + } + } + } + }, + "VirtualizationType": { + "type": "string", + "documentation": "\n

The type of virtualization.

\n

Default: paravirtual

\n " + }, + "SriovNetSupport": { + "type": "string", + "documentation": "\n

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

\n

There is no way to disable enhanced networking at this time.

\n

This option is supported only for HVM AMIs. Specifying this option\n with a PV AMI can make instances launched from the AMI unreachable.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the newly registered AMI.

\n ", + "locationName": "imageId" + } + } + }, + "errors": [ + + ], + "documentation": " \n

Registers an AMI. When you're creating an AMI, this is the final step\n\t\t\t\tyou must complete before you can launch an instance from the AMI. For more\n\t\t\t\tinformation about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

\n

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

\n

You can also use RegisterImage to create an Amazon EBS-backed AMI\n\t\t\t\tfrom a snapshot of a root device volume. For more information, see\n\t\t\t\tLaunching an\n\t\t\t\t\tInstance from a Snapshot in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n\t\t\t\tbacked by an instance store volume invalidates its registration. If you make changes to an image,\n\t\t\t\tderegister the previous image and register the new image.

\n

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

\n \n \n Example 1\n This example registers the AMI specified in the\n\t\t\t\t\tmy-new-image.manifest.xml manifest file, located in the bucket\n\t\t\t\t\tcalled myawsbucket.\n https://ec2.amazonaws.com/?Action=RegisterImage\n&ImageLocation=myawsbucket/my-new-image.manifest.xml\n&AUTHPARAMS\n <RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-1a2b3c4d</imageId>\n</RegisterImageResponse>\n \n \n Example 2\n This example registers an Amazon EBS snapshot to create an AMI backed by\n\t\t\t\t\tAmazon EBS.\n https://ec2.amazonaws.com/?Action=RegisterImage\n&RootDeviceName=/dev/sda1 \n&BlockDeviceMapping.1.DeviceName=/dev/sda1 \n&BlockDeviceMapping.1.Ebs.SnapshotId=snap-1a2b3c4d \n&Name=MyImage\n&AUTHPARAMS\n <RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-1a2b3c4d</imageId>\n</RegisterImageResponse>\n \n \n Example 3\n This example registers the AMI with an Amazon EBS snapshot as the root device,\n\t\t\t\t\ta separate snapshot as a secondary device, and an empty 100 GiB Amazon EBS\n\t\t\t\t\tvolume as a storage device.\n https://ec2.amazonaws.com/?Action=RegisterImage\n&RootDeviceName=/dev/sda1\n&BlockDeviceMapping.1.DeviceName=/dev/sda1\n&BlockDeviceMapping.1.Ebs.SnapshotId=snap-1a2b3c4d\n&BlockDeviceMapping.2.DeviceName=/dev/sdb\n&BlockDeviceMapping.2.Ebs.SnapshotId=snap-2a2b3c4d\n&BlockDeviceMapping.3.DeviceName=/dev/sdc\n&BlockDeviceMapping.3.Ebs.VolumeSize=100\n&Name=MyImage\n&AUTHPARAMS\n <RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-1a2b3c4d</imageId>\n</RegisterImageResponse>\n \n \n " + }, + "RejectVpcPeeringConnection": { + "name": "RejectVpcPeeringConnection", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "VpcPeeringConnectionId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of the VPC peering connection.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "Return": { + "type": "boolean", + "documentation": "\n

Returns true if the request succeeds; otherwise, it returns an error.

\n ", + "locationName": "return" + } + } + }, + "errors": [ + + ], + "documentation": "\n

Rejects a VPC peering connection request. The VPC peering connection must be in the\n pending-acceptance state. Use the DescribeVpcPeeringConnections request to\n view your outstanding VPC peering connection requests.

\n \n \n Example\n This example rejects the specified VPC peering connection\n request.\n https://ec2.amazonaws.com/?Action=RejectVpcPeeringConnection\n&vpcPeeringConnectionId=pcx-1a2b3c4d\n&AUTHPARAMS \n \n <RejectVpcPeeringConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</RejectVpcPeeringConnectionResponse>\n \n \n \n " + }, + "ReleaseAddress": { + "name": "ReleaseAddress", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "PublicIp": { + "type": "string", + "documentation": "\n

[EC2-Classic] The Elastic IP address.

\n " + }, + "AllocationId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The allocation ID.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Releases the specified Elastic IP address.

\n

After releasing an Elastic IP address, it is released to the IP address\n\t\t\t\tpool and might be unavailable to you. Be sure to update your DNS records and any\n\t\t\t\tservers or devices that communicate with the address. If you attempt to release\n\t\t\t\tan Elastic IP address that you already released, you'll get an\n\t\t\t\tAuthFailure error if the address is already allocated to\n\t\t\t\tanother AWS account.

\n

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address\n\t\t\t\twithout releasing it, use DisassociateAddress.

\n

[Nondefault VPC] You must use the DisassociateAddress to\n\t\t\t\tdisassociate the Elastic IP address before you try to release it. Otherwise, \n\t\t\t\tAmazon EC2 returns an error (InvalidIPAddress.InUse).

\n \n \n Example for EC2-Classic\n This example releases the specified Elastic IP address for EC2-Classic.\n https://ec2.amazonaws.com/?Action=ReleaseAddress\n&PublicIp=192.0.2.1\n&AUTHPARAMS\n \n \n Example for EC2-VPC\n This example releases the specified Elastic IP address for EC2-VPC.\n https://ec2.amazonaws.com/?Action=ReleaseAddress\n&AllocationId=eipalloc-5723d13e\n&AUTHPARAMS\n \n \n " + }, + "ReplaceNetworkAclAssociation": { + "name": "ReplaceNetworkAclAssociation", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "AssociationId", + "NetworkAclId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "AssociationId": { + "type": "string", + "documentation": "\n\t\t

The ID of the current association between the original\n\t\t\t\tnetwork ACL and the subnet.

\n " + }, + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the new ACL to associate with the subnet.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "NewAssociationId": { + "type": "string", + "documentation": "\n\t\t

The ID of the new association.

\n ", + "locationName": "newAssociationId" + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Changes which network ACL a subnet is associated with. By default when you create\n\t\t\t\ta subnet, it's automatically associated with the default network ACL. For more\n\t\t\t\tinformation about network ACLs, see Network\n\t\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example starts with a network ACL associated with a subnet, and a\n\t\t\t\t\tcorresponding association ID aclassoc-e5b95c8c. You want to associate a\n\t\t\t\t\tdifferent network ACL (acl-5fb85d36) with the subnet. The result is a new\n\t\t\t\t\tassociation ID representing the new association.\n https://ec2.amazonaws.com/?Action=ReplaceNetworkAclAssociation\n&AssociationId=aclassoc-e5b95c8c\n&NetworkAclId=acl-5fb85d36\n&AUTHPARAMS\n <ReplaceNetworkAclAssociationResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <newAssociationId>aclassoc-17b85d7e</newAssociationId>\n</ReplaceNetworkAclAssociationResponse>\n \n \n " + }, + "ReplaceNetworkAclEntry": { + "name": "ReplaceNetworkAclEntry", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkAclId": { + "type": "string", + "documentation": "\n\t\t

The ID of the ACL.

\n " + }, + "RuleNumber": { + "type": "integer", + "documentation": "\n\t\t

The rule number of the entry to replace.

\n " + }, + "Protocol": { + "type": "string", + "documentation": "\n\t\t

The IP protocol. You can specify all or -1 to mean all protocols.

\n " + }, + "RuleAction": { + "type": "string", + "enum": [ + "allow", + "deny" + ], + "documentation": "\n\t\t

Indicates whether to allow or deny the traffic that matches the rule.

\n " + }, + "Egress": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether to replace the egress rule.

\n\t\t

Default: If no value is specified, we replace the ingress rule.

\n " + }, + "CidrBlock": { + "type": "string", + "documentation": "\n\t\t

The network range to allow or deny, in CIDR notation.

\n " + }, + "IcmpTypeCode": { + "type": "structure", + "documentation": "\n\t\t

ICMP protocol: The ICMP type and code.

\n ", + "locationName": "Icmp", + "members": { + "Type": { + "type": "integer", + "documentation": "\n\t\t

The ICMP code. A value of -1 means all codes for the specified ICMP type.

\n " + }, + "Code": { + "type": "integer", + "documentation": "\n\t\t

The ICMP type. A value of -1 means all types.

\n " + } + } + }, + "PortRange": { + "type": "structure", + "documentation": "\n\t\t

TCP or UDP protocols: The range of ports the rule applies to.

\n ", + "members": { + "From": { + "type": "integer", + "documentation": "\n\t\t

The first port in the range.

\n " + }, + "To": { + "type": "integer", + "documentation": "\n\t\t

The last port in the range.

\n " + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Replaces an entry (rule) in a network ACL. For more information about network ACLs,\n\t\t\t\tsee Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example replaces the egress entry numbered 110 in the network ACL with ID\n\t\t\t\t\tacl-2cb85d45. The new rule denies egress traffic destined for anywhere\n\t\t\t\t\t(0.0.0.0/0) on TCP port 139.\n https://ec2.amazonaws.com/?Action=ReplaceNetworkAclEntry\n&NetworkAclId=acl-2cb85d45\n&RuleNumber=110\n&Protocol=tcp\n&RuleAction=deny\n&Egress=true\n&CidrBlock=0.0.0.0/0\n&PortRange.From=139\n&PortRange.To=139\n&AUTHPARAMS\n <ReplaceNetworkAclEntryResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</ReplaceNetworkAclEntryResponse>\n \n \n " + }, + "ReplaceRoute": { + "name": "ReplaceRoute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "RouteTableId", + "DestinationCidrBlock" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the route table.

\n " + }, + "DestinationCidrBlock": { + "type": "string", + "documentation": "\n\t\t

The CIDR address block used for the destination match. The value\n\t\t\t\tyou provide must match the CIDR of an existing route in the table.

\n " + }, + "GatewayId": { + "type": "string", + "documentation": "\n\t\t

The ID of an Internet gateway attached to your VPC.

\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n\t\t

The ID of a NAT instance in your VPC.

\n " + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of a network interface.

\n " + }, + "VpcPeeringConnectionId": { + "type": "string", + "documentation": "\n

The ID of a VPC peering connection.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Replaces an existing route within a route table in a VPC. You must provide only one of the following: \n\t\t Internet gateway, NAT instance, VPC peering connection, or network interface.

\n\t\t

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example replaces a route in the specified route table. The new\n\t\t\t\t\troute matches the CIDR 10.0.0.0/8 and sends the traffic to the virtual private gateway with\n\t\t\t\t\tthe ID vgw-1d00376e.\n https://ec2.amazonaws.com/?Action=ReplaceRoute\n&RouteTableId=rtb-e4ad488d\n&DestinationCidrBlock=10.0.0.0/8\n&GatewayId=vgw-1d00376e\n&AUTHPARAMS\n <ReplaceRouteResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</ReplaceRouteResponse>\n \n \n " + }, + "ReplaceRouteTableAssociation": { + "name": "ReplaceRouteTableAssociation", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "AssociationId", + "RouteTableId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "AssociationId": { + "type": "string", + "documentation": "\n\t\t

The association ID.

\n " + }, + "RouteTableId": { + "type": "string", + "documentation": "\n\t\t

The ID of the new route table to associate with the subnet.

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "NewAssociationId": { + "type": "string", + "documentation": "\n\t\t

The ID of the new association.

\n ", + "locationName": "newAssociationId" + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t

Changes the route table associated with a given subnet in a VPC. After the\n\t\t\t\toperation completes, the subnet uses the routes in the new route table it's associated with.\n\t\t\t\tFor more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

\n

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the\n\t\t\t\tVPC. You just specify the main route table's association ID and the route table to be the new main route table.

\n \n \n Example\n This example starts with a route table associated with a subnet, and a\n\t\t\t\t\tcorresponding association ID rtbassoc-f8ad4891. You want to associate a\n\t\t\t\t\tdifferent route table (table rtb-f9ad4890) to the subnet. The result is a new\n\t\t\t\t\tassociation ID representing the new association.\n https://ec2.amazonaws.com/?Action=ReplaceRouteTableAssociation\n&AssociationId=rtbassoc-f8ad4891\n&RouteTableId=rtb-f9ad4890\n&AUTHPARAMS\n \n 59dbff89-35bd-4eac-99ed-be587EXAMPLE \n rtbassoc-faad4893\n\n \n \n " + }, + "ReportInstanceStatus": { + "name": "ReportInstanceStatus", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "Instances", + "Status", + "ReasonCodes" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "Instances": { + "type": "list", + "documentation": "\n

One or more instances.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + }, + "Status": { + "type": "string", + "enum": [ + "ok", + "impaired" + ], + "documentation": "\n

The status of all instances listed.

\n " + }, + "StartTime": { + "type": "timestamp", + "documentation": "\n

The time at which the reported instance health state began.

\n " + }, + "EndTime": { + "type": "timestamp", + "documentation": "\n

The time at which the reported instance health state ended.

\n " + }, + "ReasonCodes": { + "type": "list", + "documentation": "\n

One or more reason codes that describes the health state of your instance.

\n \n ", + "flattened": true, + "member": { + "type": "string", + "enum": [ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ], + "documentation": null, + "locationName": "ReasonCode" + } + }, + "Description": { + "type": "string", + "documentation": "\n

Descriptive text about the health state of your instance.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t\t

Submits feedback about the status of an instance. The instance\n\t\t\t\tmust be in the running state. If your experience\n\t\t\t\twith the instance differs from the instance status returned by\n\t\t\t\tDescribeInstanceStatus, use ReportInstanceStatus\n\t\t\t\tto report your experience with the instance. Amazon EC2 collects\n\t\t\t\tthis information to improve the accuracy of status checks.

\n \n \n Example 1\n This example reports instance health state for two instances.\n https://ec2.amazonaws.com/?Action=ReportInstanceStatus\n&Status=impaired\n&InstanceId.0=i-9440effb\n&InstanceId.1=i-0cf27c63\n&AUTHPARAMS\n \n \n Example 2\n This example reports instance health state for two instances with reason codes.\n https://ec2.amazonaws.com/?Action=ReportInstanceStatus\n&Description=Description+of+my+issue.\n&Status=impaired\n&InstanceId.0=i-9440effb\n&InstanceId.1=i-0cf27c63\n&ReasonCode.0=instance-performance-network\n&ReasonCode.1=instance-performance-disk\n&AUTHPARAMS\n \n \n " + }, + "RequestSpotInstances": { + "name": "RequestSpotInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SpotPrice" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SpotPrice": { + "type": "string", + "documentation": "\n

The maximum hourly price for any Spot Instance launched to fulfill the request.

\n " + }, + "InstanceCount": { + "type": "integer", + "documentation": "\n

The maximum number of Spot Instances to launch.

\n

Default: 1

\n " + }, + "Type": { + "type": "string", + "enum": [ + "one-time", + "persistent" + ], + "documentation": "\n

The Spot Instance request type.

\n

Default: one-time

\n " + }, + "ValidFrom": { + "type": "timestamp", + "documentation": "\n

The start date of the request. If this is a one-time request, the\n\t\t\t\trequest becomes active at this date and time and remains active until\n\t\t\t\tall instances launch, the request expires, or the request is canceled.\n\t\t\t\tIf the request is persistent, the request becomes active at this date\n\t\t\t\tand time and remains active until it expires or is canceled.

\n

Default: The request is effective indefinitely.

\n " + }, + "ValidUntil": { + "type": "timestamp", + "documentation": "\n

The end date of the request. If this is a one-time request, the\n\t\t\t\trequest remains active until all instances launch, the request is\n\t\t\t\tcanceled, or this date is reached. If the request is persistent, it\n\t\t\t\tremains active until it is canceled or this date and time is reached.

\n

Default: The request is effective indefinitely.

\n " + }, + "LaunchGroup": { + "type": "string", + "documentation": "\n

The instance launch group. Launch groups are Spot Instances that\n\t\t\t\tlaunch together and terminate together.

\n

Default: Instances are launched and terminated individually

\n " + }, + "AvailabilityZoneGroup": { + "type": "string", + "documentation": "\n

The user-specified name for a logical grouping of bids.

\n

When you specify an Availability Zone group in a Spot\n\t\t\t\tInstance request, all Spot Instances in the request are launched in the\n\t\t\t\tsame Availability Zone. Instance proximity is maintained with this\n\t\t\t\tparameter, but the choice of Availability Zone is not.\n\t\t\t\tThe group applies only to bids for Spot\tInstances of the same instance type. \n\t\t\t\tAny additional Spot Instance requests that are specified with the same\n\t\t\t\tAvailability Zone group name are launched in that\n\t\t\t\tsame Availability Zone, as long as at least one instance from the group\n\t\t\t\tis still active.

\n

If there is no active instance running in the Availability Zone\n\t\t\t\tgroup that you specify for a new Spot Instance request (all\n\t\t\t\tinstances are terminated, the bid is expired, or the bid falls below\n\t\t\t\tcurrent market), then Amazon EC2 launches the instance in any\n\t\t\t\tAvailability Zone where the constraint can be met. Consequently, the\n\t\t\t\tsubsequent set of Spot Instances could be placed in a different zone\n\t\t\t\tfrom the original request, even if you specified the same\n\t\t\t\tAvailability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

\n " + }, + "LaunchSpecification": { + "type": "structure", + "documentation": "\n

The launch specification.

\n ", + "members": { + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n " + }, + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair.

\n " + }, + "UserData": { + "type": "string", + "documentation": "\n

The Base64-encoded MIME user data to make available to the instances.

\n " + }, + "AddressingType": { + "type": "string", + "documentation": "\n

\n " + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type.

\n " + }, + "Placement": { + "type": "structure", + "documentation": "\n

The placement information for the instance.

\n ", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone.

\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The Availability Zone group name.

\n " + } + } + }, + "KernelId": { + "type": "string", + "documentation": "\n

The ID of the kernel.

\n " + }, + "RamdiskId": { + "type": "string", + "documentation": "\n

The ID of the RAM disk.

\n " + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

One or more block device mapping entries.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "BlockDeviceMapping", + "members": { + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n " + }, + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n " + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n " + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

\n

Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.

\n " + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n " + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.

\n

Default: standard

\n " + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the\n volume supports.

\n

Constraint: Range is 100 to 4000.

\n

Condition: Required when the volume type is io1; not used with\n standard or gp2 volumes.

\n " + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is encrypted.

\n " + } + } + }, + "NoDevice": { + "type": "string", + "documentation": "\n

Suppresses the specified device included in the block device mapping of the AMI.

\n " + } + } + } + }, + "Monitoring": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean", + "documentation": "\n

Enables monitoring for the instance.

\n

Default: Disabled

\n " + } + } + }, + "SubnetId": { + "type": "string", + "documentation": "\n

The ID of the subnet in which to launch the Spot Instance.

\n " + }, + "NetworkInterfaces": { + "type": "list", + "documentation": "\n

One or more network interfaces.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a network interface.

\n ", + "locationName": "NetworkInterface", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n " + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The index of the device on the instance for the network interface attachment.

\n " + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet associated with the network string.

\n " + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

The description of the network interface.

\n " + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP address of the network interface.

\n " + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

The IDs of the security groups for the network interface.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SecurityGroupId" + } + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

If set to true, the interface is deleted when the instance is terminated.

\n " + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

One or more private IP addresses to assign to the network interface.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a secondary private IP address for a network interface.

\n ", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP addresses.

\n " + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the private IP address is the primary private IP address.

\n " + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer", + "documentation": "\n\t\t

The number of secondary private IP addresses.

\n " + }, + "AssociatePublicIpAddress": { + "type": "boolean", + "documentation": "\n

Indicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.

\n " + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "documentation": "\n

The IAM instance profile.

\n ", + "members": { + "Arn": { + "type": "string", + "documentation": "\n

The Amazon Resource Name (ARN) of the instance profile.

\n " + }, + "Name": { + "type": "string", + "documentation": "\n

The name of the instance profile.

\n " + } + } + }, + "EbsOptimized": { + "type": "boolean", + "documentation": "\n

Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.

\n

Default: false

\n " + }, + "SecurityGroupIds": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroupId" + } + }, + "SecurityGroups": { + "type": "list", + "flattened": true, + "member": { + "type": "string", + "locationName": "SecurityGroup" + } + } + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "SpotInstanceRequests": { + "type": "list", + "documentation": "\n

Information about the Spot Instance request.

\n ", + "locationName": "spotInstanceRequestSet", + "member": { + "type": "structure", + "documentation": "\n

Describe a Spot Instance request.

\n ", + "locationName": "item", + "members": { + "SpotInstanceRequestId": { + "type": "string", + "documentation": "\n

The ID of the Spot Instance request.

\n ", + "locationName": "spotInstanceRequestId" + }, + "SpotPrice": { + "type": "string", + "documentation": "\n

The maximum hourly price for any Spot Instance launched to fulfill the request.

\n ", + "locationName": "spotPrice" + }, + "Type": { + "type": "string", + "enum": [ + "one-time", + "persistent" + ], + "documentation": "\n

The Spot Instance request type.

\n ", + "locationName": "type" + }, + "State": { + "type": "string", + "enum": [ + "open", + "active", + "closed", + "cancelled", + "failed" + ], + "documentation": "\n

The state of the Spot Instance request. Spot bid status information can help you track your \n\t\t\t\tSpot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

\n ", + "locationName": "state" + }, + "Fault": { + "type": "structure", + "documentation": "\n

The fault codes for the Spot Instance request, if any.

\n ", + "locationName": "fault", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The reason code for the Spot Instance state change.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

The message for the Spot Instance state change.

\n ", + "locationName": "message" + } + } + }, + "Status": { + "type": "structure", + "documentation": "\n

The status code and status message describing the Spot Instance request.

\n ", + "locationName": "status", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The status code of the request.

\n ", + "locationName": "code" + }, + "UpdateTime": { + "type": "timestamp", + "documentation": "\n

The time of the most recent status update.

\n ", + "locationName": "updateTime" + }, + "Message": { + "type": "string", + "documentation": "\n

The description for the status code for the Spot request.

\n ", + "locationName": "message" + } + } + }, + "ValidFrom": { + "type": "timestamp", + "documentation": "\n

The start date of the request. If this is a one-time request, the request becomes\n\t\t\t\tactive at this date and time and remains active until all\n\t\t\t\tinstances launch, the request expires, or the request is\n\t\t\t\tcanceled. If the request is persistent, the request becomes\n\t\t\t\tactive at this date and time and remains active until it expires\n\t\t\t\tor is canceled.

\n ", + "locationName": "validFrom" + }, + "ValidUntil": { + "type": "timestamp", + "documentation": "\n

The end date of the request. If this is a one-time request, the request remains\n\t\t\t\tactive until all instances launch, the request is canceled, or\n\t\t\t\tthis date is reached. If the request is persistent, it remains\n\t\t\t\tactive until it is canceled or this date is reached.

\n ", + "locationName": "validUntil" + }, + "LaunchGroup": { + "type": "string", + "documentation": "\n

The instance launch group. Launch groups are Spot Instances that launch\n\t\t\t\ttogether and terminate together.

\n ", + "locationName": "launchGroup" + }, + "AvailabilityZoneGroup": { + "type": "string", + "documentation": "\n

The Availability Zone group. If you specify the same Availability Zone group\n\t\t\t\tfor all Spot Instance requests, all Spot Instances are launched in the same\n\t\t\t\tAvailability Zone.

\n ", + "locationName": "availabilityZoneGroup" + }, + "LaunchSpecification": { + "type": "structure", + "documentation": "\n

Additional information for launching instances.

\n ", + "locationName": "launchSpecification", + "members": { + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n ", + "locationName": "imageId" + }, + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair.

\n ", + "locationName": "keyName" + }, + "SecurityGroups": { + "type": "list", + "documentation": "\n

One or more security groups.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "UserData": { + "type": "string", + "documentation": "\n

The Base64-encoded MIME user data to make available to the instances.

\n ", + "locationName": "userData" + }, + "AddressingType": { + "type": "string", + "documentation": "\n

\n ", + "locationName": "addressingType" + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type.

\n ", + "locationName": "instanceType" + }, + "Placement": { + "type": "structure", + "documentation": "\n

The placement information for the instance.

\n ", + "locationName": "placement", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone.

\n ", + "locationName": "availabilityZone" + }, + "GroupName": { + "type": "string", + "documentation": "\n

The Availability Zone group name.

\n ", + "locationName": "groupName" + } + } + }, + "KernelId": { + "type": "string", + "documentation": "\n

The ID of the kernel.

\n ", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "documentation": "\n

The ID of the RAM disk.

\n ", + "locationName": "ramdiskId" + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

One or more block device mapping entries.

\n ", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "item", + "members": { + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n ", + "locationName": "virtualName" + }, + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n ", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "locationName": "ebs", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n ", + "locationName": "snapshotId" + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

\n

Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.

\n ", + "locationName": "volumeSize" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.

\n

Default: standard

\n ", + "locationName": "volumeType" + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the\n volume supports.

\n

Constraint: Range is 100 to 4000.

\n

Condition: Required when the volume type is io1; not used with\n standard or gp2 volumes.

\n ", + "locationName": "iops" + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is encrypted.

\n ", + "locationName": "encrypted" + } + } + }, + "NoDevice": { + "type": "string", + "documentation": "\n

Suppresses the specified device included in the block device mapping of the AMI.

\n ", + "locationName": "noDevice" + } + } + } + }, + "MonitoringEnabled": { + "type": "boolean", + "documentation": "\n

Enables monitoring for the instance.

\n

Default: Disabled

\n ", + "locationName": "monitoringEnabled" + }, + "SubnetId": { + "type": "string", + "documentation": "\n

The ID of the subnet in which to launch the Spot Instance.

\n ", + "locationName": "subnetId" + }, + "NetworkInterfaces": { + "type": "list", + "documentation": "\n

One or more network interfaces.

\n ", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a network interface.

\n ", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The index of the device on the instance for the network interface attachment.

\n ", + "locationName": "deviceIndex" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet associated with the network string.

\n ", + "locationName": "subnetId" + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

The description of the network interface.

\n ", + "locationName": "description" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP address of the network interface.

\n ", + "locationName": "privateIpAddress" + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

The IDs of the security groups for the network interface.

\n ", + "locationName": "SecurityGroupId", + "member": { + "type": "string", + "documentation": null, + "locationName": "SecurityGroupId" + } + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

If set to true, the interface is deleted when the instance is terminated.

\n ", + "locationName": "deleteOnTermination" + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

One or more private IP addresses to assign to the network interface.

\n ", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a secondary private IP address for a network interface.

\n ", + "locationName": "item", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP addresses.

\n ", + "locationName": "privateIpAddress" + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the private IP address is the primary private IP address.

\n ", + "locationName": "primary" + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer", + "documentation": "\n\t\t

The number of secondary private IP addresses.

\n ", + "locationName": "secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress": { + "type": "boolean", + "documentation": "\n

Indicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.

\n ", + "locationName": "associatePublicIpAddress" + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "documentation": "\n

The IAM instance profile.

\n ", + "locationName": "iamInstanceProfile", + "members": { + "Arn": { + "type": "string", + "documentation": "\n

The Amazon Resource Name (ARN) of the instance profile.

\n ", + "locationName": "arn" + }, + "Name": { + "type": "string", + "documentation": "\n

The name of the instance profile.

\n ", + "locationName": "name" + } + } + }, + "EbsOptimized": { + "type": "boolean", + "documentation": "\n

Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.

\n

Default: false

\n ", + "locationName": "ebsOptimized" + } + } + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The instance ID, if an instance has been launched to fulfill the Spot Instance\n\t\t\t\trequest.

\n ", + "locationName": "instanceId" + }, + "CreateTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the Spot Instance request was created.

\n ", + "locationName": "createTime" + }, + "ProductDescription": { + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\n

The product description associated with the Spot Instance.

\n ", + "locationName": "productDescription" + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the resource.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "LaunchedAvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone in which the bid is launched.

\n ", + "locationName": "launchedAvailabilityZone" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Creates a Spot Instance request. Spot Instances are instances that Amazon EC2\n\t\t\t\tstarts on your behalf when the maximum price that you specify exceeds the current\n\t\t\t\tSpot Price. Amazon EC2 periodically sets the Spot Price based on available Spot\n\t\t\t\tInstance capacity and current Spot Instance requests. For more information about\n\t\t\t\tSpot Instances, see Spot\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example creates a Spot Instance request for two m1.small\n\t\t\t\t\tinstances and associates an IAM instance profile called s3access\n\t\t\t\t\twith them.\n https://ec2.amazonaws.com/?Action=RequestSpotInstances\n&SpotPrice=0.50\n&InstanceCount=2\n&Type=one-time\n&AvailabilityZoneGroup=MyAzGroup\n&LaunchSpecification.ImageId=ami-1a2b3c4d\n&LaunchSpecification.KeyName=my-key-pair\n&LaunchSpecification.SecurityGroup.1=websrv\n&LaunchSpecification.InstanceType=m1.small\n&LaunchSpecification.IamInstanceProfile.Name=s3access\n&AUTHPARAMS\n <RequestSpotInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n \n \n sir-1a2b3c4d\n 0.5\n one-time\n open\n \n pending-evaluation\n YYYY-MM-DDTHH:MM:SS.000Z\n Your Spot request has been submitted for review, and is pending evaluation.\n \n MyAzGroup\n \n ami-1a2b3c4d\n my-key-pair\n \n \n sg-1a2b3c4d\n websrv\n \n \n m1.small\n \n \n false\n \n false\n \n YYYY-MM-DDTHH:MM:SS.000Z\n Linux/UNIX\n \n \n\n \n \n " + }, + "ResetImageAttribute": { + "name": "ResetImageAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ImageId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "launchPermission" + ], + "documentation": "\n

The attribute to reset (currently you can only reset the launch\n\t\t\t\tpermission attribute).

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": " \n

Resets an attribute of an AMI to its default value.

\n \n \n Example\n This example resets the launchPermission attribute for the\n\t\t\t\t\tspecified AMI.\n https://ec2.amazonaws.com/?Action=ResetImageAttribute\n&ImageId=ami-61a54008\n&Attribute=launchPermission\n&AUTHPARAMS\n <ResetImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</ResetImageAttributeResponse>\n \n \n " + }, + "ResetInstanceAttribute": { + "name": "ResetInstanceAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ], + "documentation": "\n

The attribute to reset.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t\t

Resets an attribute of an instance to its default value. To reset the kernel or\n\t\t\t\tRAM disk, the instance must be in a stopped state. To reset the\n\t\t\t\tSourceDestCheck, the instance can be either running or stopped.

\n\t\t\t

The SourceDestCheck attribute controls whether\n\t\t\t\tsource/destination checking is enabled. The default value is\n\t\t\t\ttrue, which means checking is enabled. This value must be\n\t\t\t\tfalse for a NAT instance to perform NAT. For more information, see\n\t\t\t\tNAT Instances in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n \n Example\n This example resets the sourceDestCheck attribute.\n https://ec2.amazonaws.com/?Action=ResetInstanceAttribute\n&InstanceId=i-1a2b3c4d\n&Attribute=sourceDestCheck\n&AUTHPARAMS\n <ResetInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</ResetInstanceAttributeResponse>\n \n \n " + }, + "ResetNetworkInterfaceAttribute": { + "name": "ResetNetworkInterfaceAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkInterfaceId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n " + }, + "SourceDestCheck": { + "type": "string", + "documentation": "\n\t\t

Indicates whether source/destination checking is enabled. A value\n\t\t\t\tof true means checking is enabled, and\n\t\t\t\tfalse means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT.

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Resets a network interface attribute. You can specify only one attribute at a time.

\n \n \n Example\n This example resets the sourceDestCheck attribute for the \n\t\t\t\t specified network interface.\n https://ec2.amazonaws.com/?Action=ResetNetworkInterfaceAttribute\n&NetworkInterfaceId=eni-ffda3197\n&Attribute=sourceDestCheck\n&AUTHPARAMS\n <ResetNetworkInterfaceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>5187642e-3f16-44a3-b05f-24c3848b5162</requestId>\n <return>true</return>\n</ResetNetworkInterfaceAttributeResponse>\n \n \n " + }, + "ResetSnapshotAttribute": { + "name": "ResetSnapshotAttribute", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "SnapshotId", + "Attribute" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n " + }, + "Attribute": { + "type": "string", + "enum": [ + "productCodes", + "createVolumePermission" + ], + "documentation": "\n

The attribute to reset (currently only the attribute for permission to create volumes can be\n reset).

\n " + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Resets permission settings for the specified snapshot.

\n

For more information on modifying snapshot permissions, see Sharing Snapshots in the\n Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example resets the permissions for snap-1a2b3c4d, making it a\n private snapshot that can only be used by the account that created it.\n https://ec2.amazonaws.com/?Action=ResetSnapshotAttribute\n&SnapshotId=snap-1a2b3c4d\n&Attribute=createVolumePermission\n&AUTHPARAMS\n <ResetSnapshotAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</ResetSnapshotAttributeResponse>\n \n \n " + }, + "RevokeSecurityGroupEgress": { + "name": "RevokeSecurityGroupEgress", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "GroupId" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n " + }, + "SourceSecurityGroupName": { + "type": "string", + "documentation": "\n

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

\n " + }, + "SourceSecurityGroupOwnerId": { + "type": "string", + "documentation": "\n

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

\n " + }, + "IpProtocol": { + "type": "string", + "documentation": "\n

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

\n " + }, + "FromPort": { + "type": "integer", + "documentation": "\n

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.

\n " + }, + "ToPort": { + "type": "integer", + "documentation": "\n

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.

\n " + }, + "CidrIp": { + "type": "string", + "documentation": "\n

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

\n " + }, + "IpPermissions": { + "type": "list", + "documentation": "\n

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a security group rule.

\n ", + "members": { + "IpProtocol": { + "type": "string", + "documentation": "\n\t\t

The protocol.

\n\t\t

When you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.

\n " + }, + "FromPort": { + "type": "integer", + "documentation": "\n\t\t

The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.

\n " + }, + "ToPort": { + "type": "integer", + "documentation": "\n\t\t

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.

\n " + }, + "UserIdGroupPairs": { + "type": "list", + "documentation": "\n\t\t

One or more security group and AWS account ID pairs.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a security group and AWS account ID pair for EC2-Classic.

\n ", + "locationName": "Groups", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The ID of an AWS account.

\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The ID of the security group owned by the specified AWS account.

\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The name of the security group in the specified AWS account.

\n " + } + } + } + }, + "IpRanges": { + "type": "list", + "documentation": "\n\t\t

One or more IP ranges.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an IP range.

\n ", + "members": { + "CidrIp": { + "type": "string", + "documentation": "\n\t\t

The CIDR range. You can either specify a CIDR range or a source security group, not both.

\n " + } + } + } + } + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Removes one or more egress rules from a security group for EC2-VPC. The values\n\t\t\t\tthat you specify in the revoke request (for example, ports) must match the existing\n\t\t\t\trule's values for the rule to be revoked.

\n

Each rule consists of the protocol and the CIDR range or source security\n\t\t\t\tgroup. For the TCP and UDP protocols, you must also specify the destination port or\n\t\t\t\trange of ports. For the ICMP protocol, you must also specify the ICMP type and code.

\n

Rule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.

\n \n \n Example 1\n This example revokes the access that the specified security group\n\t\t\t\t\thas to the 205.192.0.0/16 and 205.159.0.0/16\n\t\t\t\t\taddress ranges on TCP port 80.\n https://ec2.amazonaws.com/?Action=RevokeSecurityGroupEgress\n&GroupId=sg-1a2b3c4d\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=80\n&IpPermissions.1.ToPort=80\n&IpPermissions.1.IpRanges.1.CidrIp=205.192.0.0/16\n&IpPermissions.1.IpRanges.2.CidrIp=205.159.0.0/16\n&AUTHPARAMS\n \n \n Example 2\n This example revokes the access that the specified security group \n\t\t\t\t\thas to the security group with the ID sg-9a8d7f5c on TCP\tport 1433.\n https://ec2.amazonaws.com/?Action=RevokeSecurityGroupEgress\n&GroupId=sg-1a2b3c4d\n&IpPermissions.1.IpProtocol=tcp\n&IpPermissions.1.FromPort=1433\n&IpPermissions.1.ToPort=1433\n&IpPermissions.1.Groups.1.GroupId=sg-9a8d7f5c\n&AUTHPARAMS\n \n \n " + }, + "RevokeSecurityGroupIngress": { + "name": "RevokeSecurityGroupIngress", + "input": { + "type": "structure", + "documentation": "\n ", + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

[EC2-Classic, default VPC] The name of the security group.

\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n " + }, + "SourceSecurityGroupName": { + "type": "string", + "documentation": "\n

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

\n " + }, + "SourceSecurityGroupOwnerId": { + "type": "string", + "documentation": "\n

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

\n " + }, + "IpProtocol": { + "type": "string", + "documentation": "\n

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

\n " + }, + "FromPort": { + "type": "integer", + "documentation": "\n

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.

\n " + }, + "ToPort": { + "type": "integer", + "documentation": "\n

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.

\n " + }, + "CidrIp": { + "type": "string", + "documentation": "\n

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

\n " + }, + "IpPermissions": { + "type": "list", + "documentation": "\n

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a security group rule.

\n ", + "members": { + "IpProtocol": { + "type": "string", + "documentation": "\n\t\t

The protocol.

\n\t\t

When you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.

\n " + }, + "FromPort": { + "type": "integer", + "documentation": "\n\t\t

The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.

\n " + }, + "ToPort": { + "type": "integer", + "documentation": "\n\t\t

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.

\n " + }, + "UserIdGroupPairs": { + "type": "list", + "documentation": "\n\t\t

One or more security group and AWS account ID pairs.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a security group and AWS account ID pair for EC2-Classic.

\n ", + "locationName": "Groups", + "members": { + "UserId": { + "type": "string", + "documentation": "\n

The ID of an AWS account.

\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The ID of the security group owned by the specified AWS account.

\n " + }, + "GroupId": { + "type": "string", + "documentation": "\n

The name of the security group in the specified AWS account.

\n " + } + } + } + }, + "IpRanges": { + "type": "list", + "documentation": "\n\t\t

One or more IP ranges.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes an IP range.

\n ", + "members": { + "CidrIp": { + "type": "string", + "documentation": "\n\t\t

The CIDR range. You can either specify a CIDR range or a source security group, not both.

\n " + } + } + } + } + } + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n

Removes one or more ingress rules from a security group. The values\n\t\t\t\tthat you specify in the revoke request (for example, ports) must match the existing\n\t\t\t\trule's values for the rule to be removed.

\n

Each rule consists of the protocol and the CIDR range or source security\n\t\t\t\tgroup. For the TCP and UDP protocols, you must also specify the destination port or\n\t\t\t\trange of ports. For the ICMP protocol, you must also specify the ICMP type and code.

\n

Rule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.

\n \n \n Example\n This example revokes TCP port 80 access from the 205.192.0.0/16 address range\n\t\t\t\t\tfor the security group named websrv. If the security group is for\n\t\t\t\t\ta VPC, specify the ID of the security group instead of the name.\n https://ec2.amazonaws.com/?Action=RevokeSecurityGroupIngress\n&GroupName=websrv\n&IpProtocol=tcp\n&FromPort=80\n&ToPort=80\n&CidrIp=205.192.0.0/16\n&AUTHPARAMS\n <RevokeSecurityGroupIngressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</RevokeSecurityGroupIngressResponse>\n \n \n " + }, + "RunInstances": { + "name": "RunInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "ImageId", + "MinCount", + "MaxCount" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI, which you can get by calling DescribeImages.

\n " + }, + "MinCount": { + "type": "integer", + "documentation": "\n

The minimum number of instances to launch. If you specify a minimum that is more instances\n than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. \n For more information about the default limits, and how to request an increase, see \n How\n many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

\n " + }, + "MaxCount": { + "type": "integer", + "documentation": "\n

The maximum number of instances to launch. If you specify more instances\n than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the\n largest possible number of instances above MinCount.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. \n For more information about the default limits, and how to request an increase, see \n How\n many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

\n " + }, + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

\n \n

If you launch an instance without specifying a key pair, you can't connect to the instance.

\n \n " + }, + "SecurityGroups": { + "type": "list", + "documentation": "\n

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use\n security group IDs instead.

\n

Default: Amazon EC2 uses the default security group.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SecurityGroup" + } + }, + "SecurityGroupIds": { + "type": "list", + "documentation": "\n

One or more security group IDs. You can create a security group using CreateSecurityGroup.

\n

Default: Amazon EC2 uses the default security group.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SecurityGroupId" + } + }, + "UserData": { + "type": "string", + "documentation": "\n

The Base64-encoded MIME user data for the instances.

\n " + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

\n

Default: m1.small

\n " + }, + "Placement": { + "type": "structure", + "documentation": "\n

The placement for the instance.

\n ", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone of the instance.

\n " + }, + "GroupName": { + "type": "string", + "documentation": "\n

The name of the placement group the instance is in (for cluster compute instances).

\n " + }, + "Tenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n

The tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.

\n " + } + } + }, + "KernelId": { + "type": "string", + "documentation": "\n

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information,\n see \n PV-GRUB: A New Amazon Kernel Image in the Amazon Elastic Compute Cloud User Guide.

\n \n " + }, + "RamdiskId": { + "type": "string", + "documentation": "\n

The ID of the RAM disk.

\n " + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

The block device mapping.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "BlockDeviceMapping", + "members": { + "VirtualName": { + "type": "string", + "documentation": "\n

The virtual device name.

\n " + }, + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n " + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "members": { + "SnapshotId": { + "type": "string", + "documentation": "\n

The ID of the snapshot.

\n " + }, + "VolumeSize": { + "type": "integer", + "documentation": "\n

The size of the volume, in GiB.

\n

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

\n

Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.

\n " + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is deleted on instance termination.

\n " + }, + "VolumeType": { + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\n

The volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.

\n

Default: standard

\n " + }, + "Iops": { + "type": "integer", + "documentation": "\n

The number of I/O operations per second (IOPS) that the\n volume supports.

\n

Constraint: Range is 100 to 4000.

\n

Condition: Required when the volume type is io1; not used with\n standard or gp2 volumes.

\n " + }, + "Encrypted": { + "type": "boolean", + "documentation": "\n

Indicates whether the Amazon EBS volume is encrypted.

\n " + } + } + }, + "NoDevice": { + "type": "string", + "documentation": "\n

Suppresses the specified device included in the block device mapping of the AMI.

\n " + } + } + } + }, + "Monitoring": { + "type": "structure", + "documentation": "\n

The monitoring for the instance.

\n ", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean", + "documentation": "\n

Indicates whether monitoring is enabled for the instance.

\n " + } + } + }, + "SubnetId": { + "type": "string", + "documentation": "\n

[EC2-VPC] The ID of the subnet to launch the instance into.

\n " + }, + "DisableApiTermination": { + "type": "boolean", + "documentation": "\n

If you set this parameter to true, you can't terminate the instance using the Amazon EC2\n console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want\n to be able to terminate the instance, you must first change the value of the\n disableApiTermination attribute to false using\n ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate,\n you can terminate the instance by running the shutdown command from the instance.

\n

Default: false

\n " + }, + "InstanceInitiatedShutdownBehavior": { + "type": "string", + "enum": [ + "stop", + "terminate" + ], + "documentation": "\n

Indicates whether an instance stops or terminates when you initiate\n shutdown from the instance (using the operating system command for system shutdown).

\n

Default: stop

\n " + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n

[EC2-VPC] The primary IP address. You must specify a value\n from the IP address range of the subnet.

\n

Only one private IP address can be designated as primary.\n Therefore, you can't specify this parameter if\n PrivateIpAddresses.n.Primary is set to\n true and PrivateIpAddresses.n.PrivateIpAddress\n is set to an IP address.

\n

Default: We select an IP address from the IP address range of the subnet.

\n " + }, + "ClientToken": { + "type": "string", + "documentation": "\n

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information,\n see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

\n

Constraints: Maximum 64 ASCII characters

\n " + }, + "AdditionalInfo": { + "type": "string", + "documentation": "\n

Reserved.

\n " + }, + "NetworkInterfaces": { + "type": "list", + "documentation": "\n

One or more network interfaces.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a network interface.

\n ", + "locationName": "NetworkInterface", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n " + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The index of the device on the instance for the network interface attachment.

\n " + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet associated with the network string.

\n " + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

The description of the network interface.

\n " + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP address of the network interface.

\n " + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

The IDs of the security groups for the network interface.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "SecurityGroupId" + } + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

If set to true, the interface is deleted when the instance is terminated.

\n " + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

One or more private IP addresses to assign to the network interface.

\n ", + "flattened": true, + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a secondary private IP address for a network interface.

\n ", + "required": [ + "PrivateIpAddress" + ], + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP addresses.

\n " + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the private IP address is the primary private IP address.

\n " + } + } + } + }, + "SecondaryPrivateIpAddressCount": { + "type": "integer", + "documentation": "\n\t\t

The number of secondary private IP addresses.

\n " + }, + "AssociatePublicIpAddress": { + "type": "boolean", + "documentation": "\n

Indicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.

\n " + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "documentation": "\n

The IAM instance profile.

\n ", + "members": { + "Arn": { + "type": "string", + "documentation": "\n

The Amazon Resource Name (ARN) of the instance profile.

\n " + }, + "Name": { + "type": "string", + "documentation": "\n

The name of the instance profile.

\n " + } + } + }, + "EbsOptimized": { + "type": "boolean", + "documentation": "\n

Indicates whether the instance is optimized for EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized\n configuration stack to provide optimal Amazon EBS I/O performance. This\n optimization isn't available with all instance types. Additional usage\n charges apply when using an EBS-optimized instance.

\n

Default: false

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n

One or more reservations.

\n ", + "locationName": "reservation", + "members": { + "ReservationId": { + "type": "string", + "documentation": "\n

The ID of the reservation.

\n ", + "locationName": "reservationId" + }, + "OwnerId": { + "type": "string", + "documentation": "\n

The ID of the AWS account that owns the reservation.

\n ", + "locationName": "ownerId" + }, + "RequesterId": { + "type": "string", + "documentation": "\n

The ID of the requester that launched the instances on your behalf (for example,\n\t\t\t\tAWS Management Console or Auto Scaling).

\n ", + "locationName": "requesterId" + }, + "Groups": { + "type": "list", + "documentation": "\n

One or more security groups.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "Instances": { + "type": "list", + "documentation": "\n

One or more instances.

\n ", + "locationName": "instancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an instance.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "ImageId": { + "type": "string", + "documentation": "\n

The ID of the AMI used to launch the instance.

\n ", + "locationName": "imageId" + }, + "State": { + "type": "structure", + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "instanceState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n

The private DNS name assigned to the instance. This DNS name can only be used\n\t\t\t\tinside the Amazon EC2 network. This name is not available until the instance enters\n\t\t\t\tthe running state.

\n ", + "locationName": "privateDnsName" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n

The public DNS name assigned to the instance.\n\t\t\t\tThis name is not available until the instance enters the running state.

\n ", + "locationName": "dnsName" + }, + "StateTransitionReason": { + "type": "string", + "documentation": "\n

The reason for the most recent state transition. This might be an empty string.

\n ", + "locationName": "reason" + }, + "KeyName": { + "type": "string", + "documentation": "\n

The name of the key pair, if this instance was launched with an associated key pair.

\n ", + "locationName": "keyName" + }, + "AmiLaunchIndex": { + "type": "integer", + "documentation": "\n

The AMI launch index, which can be used to find this instance in the launch group.

\n ", + "locationName": "amiLaunchIndex" + }, + "ProductCodes": { + "type": "list", + "documentation": "\n

The product codes attached to this instance.

\n ", + "locationName": "productCodes", + "member": { + "type": "structure", + "documentation": "\n

Describes a product code.

\n ", + "locationName": "item", + "members": { + "ProductCodeId": { + "type": "string", + "documentation": "\n

The product code.

\n ", + "locationName": "productCode" + }, + "ProductCodeType": { + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\n

The type of product code.

\n ", + "locationName": "type" + } + } + } + }, + "InstanceType": { + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\n

The instance type.

\n ", + "locationName": "instanceType" + }, + "LaunchTime": { + "type": "timestamp", + "documentation": "\n

The time the instance was launched.

\n ", + "locationName": "launchTime" + }, + "Placement": { + "type": "structure", + "documentation": "\n

The location where the instance launched.

\n ", + "locationName": "placement", + "members": { + "AvailabilityZone": { + "type": "string", + "documentation": "\n

The Availability Zone of the instance.

\n ", + "locationName": "availabilityZone" + }, + "GroupName": { + "type": "string", + "documentation": "\n

The name of the placement group the instance is in (for cluster compute instances).

\n ", + "locationName": "groupName" + }, + "Tenancy": { + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n

The tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.

\n ", + "locationName": "tenancy" + } + } + }, + "KernelId": { + "type": "string", + "documentation": "\n

The kernel associated with this instance.

\n ", + "locationName": "kernelId" + }, + "RamdiskId": { + "type": "string", + "documentation": "\n

The RAM disk associated with this instance.

\n ", + "locationName": "ramdiskId" + }, + "Platform": { + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\n

The value is Windows for Windows instances; otherwise blank.

\n ", + "locationName": "platform" + }, + "Monitoring": { + "type": "structure", + "documentation": "\n

The monitoring information for the instance.

\n ", + "locationName": "monitoring", + "members": { + "State": { + "type": "string", + "enum": [ + "disabled", + "enabled", + "pending" + ], + "documentation": "\n

Indicates whether monitoring is enabled for the instance.

\n ", + "locationName": "state" + } + } + }, + "SubnetId": { + "type": "string", + "documentation": "\n

The ID of the subnet in which the instance is running.

\n ", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "documentation": "\n

The ID of the VPC in which the instance is running.

\n ", + "locationName": "vpcId" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n

The private IP address assigned to the instance.

\n ", + "locationName": "privateIpAddress" + }, + "PublicIpAddress": { + "type": "string", + "documentation": "\n

The public IP address assigned to the instance.

\n ", + "locationName": "ipAddress" + }, + "StateReason": { + "type": "structure", + "documentation": "\n

The reason for the most recent state transition.

\n ", + "locationName": "stateReason", + "members": { + "Code": { + "type": "string", + "documentation": "\n

The reason code for the state change.

\n ", + "locationName": "code" + }, + "Message": { + "type": "string", + "documentation": "\n

The message for the state change.

\n \n ", + "locationName": "message" + } + } + }, + "Architecture": { + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\n

The architecture of the image.

\n ", + "locationName": "architecture" + }, + "RootDeviceType": { + "type": "string", + "enum": [ + "ebs", + "instance-store" + ], + "documentation": "\n

The root device type used by the AMI. The AMI can use an Amazon EBS volume\n or an instance store volume.

\n ", + "locationName": "rootDeviceType" + }, + "RootDeviceName": { + "type": "string", + "documentation": "\n

The root device name (for example, /dev/sda1).

\n ", + "locationName": "rootDeviceName" + }, + "BlockDeviceMappings": { + "type": "list", + "documentation": "\n

Any block device mapping entries for the instance.

\n ", + "locationName": "blockDeviceMapping", + "member": { + "type": "structure", + "documentation": "\n

Describes a block device mapping.

\n ", + "locationName": "item", + "members": { + "DeviceName": { + "type": "string", + "documentation": "\n

The device name exposed to the instance (for example, /dev/sdh).

\n ", + "locationName": "deviceName" + }, + "Ebs": { + "type": "structure", + "documentation": "\n

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

\n ", + "locationName": "ebs", + "members": { + "VolumeId": { + "type": "string", + "documentation": "\n

The ID of the Amazon EBS volume.

\n ", + "locationName": "volumeId" + }, + "Status": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n

The attachment state.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n

Indicates whether the volume is deleted on instance termination.

\n ", + "locationName": "deleteOnTermination" + } + } + } + } + } + }, + "VirtualizationType": { + "type": "string", + "enum": [ + "hvm", + "paravirtual" + ], + "documentation": "\n

The virtualization type of the instance.

\n ", + "locationName": "virtualizationType" + }, + "InstanceLifecycle": { + "type": "string", + "enum": [ + "spot" + ], + "documentation": "\n

Indicates whether this is a Spot Instance.

\n ", + "locationName": "instanceLifecycle" + }, + "SpotInstanceRequestId": { + "type": "string", + "documentation": "\n

The ID of the Spot Instance request.

\n ", + "locationName": "spotInstanceRequestId" + }, + "ClientToken": { + "type": "string", + "documentation": "\n

The idempotency token you provided when you launched the instance.

\n ", + "locationName": "clientToken" + }, + "Tags": { + "type": "list", + "documentation": "\n

Any tags assigned to the instance.

\n ", + "locationName": "tagSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a tag.

\n ", + "locationName": "item", + "members": { + "Key": { + "type": "string", + "documentation": "\n

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:

\n ", + "locationName": "key" + }, + "Value": { + "type": "string", + "documentation": "\n

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.

\n ", + "locationName": "value" + } + } + } + }, + "SecurityGroups": { + "type": "list", + "documentation": "\n

One or more security groups for the instance.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "SourceDestCheck": { + "type": "boolean", + "documentation": "\n

Specifies whether to enable an instance launched in a VPC to\n\t\t\t\tperform NAT. This controls whether source/destination checking\n\t\t\t\tis enabled on the instance. A value of true means\n\t\t\t\tchecking is enabled, and false means checking is\n\t\t\t\tdisabled. The value must be false for the instance\n\t\t\t\tto perform NAT. For more information, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.

\n ", + "locationName": "sourceDestCheck" + }, + "Hypervisor": { + "type": "string", + "enum": [ + "ovm", + "xen" + ], + "documentation": "\n

The hypervisor type of the instance.

\n ", + "locationName": "hypervisor" + }, + "NetworkInterfaces": { + "type": "list", + "documentation": "\n

[EC2-VPC] One or more network interfaces for the instance.

\n ", + "locationName": "networkInterfaceSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a network interface.

\n ", + "locationName": "item", + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n ", + "locationName": "networkInterfaceId" + }, + "SubnetId": { + "type": "string", + "documentation": "\n\t\t

The ID of the subnet.

\n ", + "locationName": "subnetId" + }, + "VpcId": { + "type": "string", + "documentation": "\n\t\t

The ID of the VPC.

\n ", + "locationName": "vpcId" + }, + "Description": { + "type": "string", + "documentation": "\n\t\t

The description.

\n ", + "locationName": "description" + }, + "OwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the AWS account that created the network interface.

\n ", + "locationName": "ownerId" + }, + "Status": { + "type": "string", + "enum": [ + "available", + "attaching", + "in-use", + "detaching" + ], + "documentation": "\n\t\t

The status of the network interface.

\n ", + "locationName": "status" + }, + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The IP address of the network interface within the subnet.

\n ", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n\t\t

The private DNS name.

\n ", + "locationName": "privateDnsName" + }, + "SourceDestCheck": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether to validate network traffic to or from this network interface.

\n ", + "locationName": "sourceDestCheck" + }, + "Groups": { + "type": "list", + "documentation": "\n\t\t

One or more security groups.

\n ", + "locationName": "groupSet", + "member": { + "type": "structure", + "documentation": "\n

Describes a security group.

\n ", + "locationName": "item", + "members": { + "GroupName": { + "type": "string", + "documentation": "\n

The name of the security group.

\n ", + "locationName": "groupName" + }, + "GroupId": { + "type": "string", + "documentation": "\n

The ID of the security group.

\n ", + "locationName": "groupId" + } + } + } + }, + "Attachment": { + "type": "structure", + "documentation": "\n\t\t

The network interface attachment.

\n ", + "locationName": "attachment", + "members": { + "AttachmentId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface attachment.

\n ", + "locationName": "attachmentId" + }, + "DeviceIndex": { + "type": "integer", + "documentation": "\n\t\t

The index of the device on the instance for the network interface attachment.

\n ", + "locationName": "deviceIndex" + }, + "Status": { + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\t

The attachment state.

\n ", + "locationName": "status" + }, + "AttachTime": { + "type": "timestamp", + "documentation": "\n\t\t

The time stamp when the attachment initiated.

\n ", + "locationName": "attachTime" + }, + "DeleteOnTermination": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether the network interface is deleted when the instance is terminated.

\n ", + "locationName": "deleteOnTermination" + } + } + }, + "Association": { + "type": "structure", + "documentation": "\n\t\t

The association information for an Elastic IP associated with the network interface.

\n ", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The address of the Elastic IP address bound to the network interface.

\n ", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n\t\t

The public DNS name.

\n ", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the owner of the Elastic IP address.

\n ", + "locationName": "ipOwnerId" + } + } + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

The private IP addresses associated with the network interface.

\n ", + "locationName": "privateIpAddressesSet", + "member": { + "type": "structure", + "documentation": "\n\t\t

Describes a private IP address.

\n ", + "locationName": "item", + "members": { + "PrivateIpAddress": { + "type": "string", + "documentation": "\n\t\t

The private IP address of the network interface.

\n ", + "locationName": "privateIpAddress" + }, + "PrivateDnsName": { + "type": "string", + "documentation": "\n\t\t

The private DNS name.

\n ", + "locationName": "privateDnsName" + }, + "Primary": { + "type": "boolean", + "documentation": "\n\t\t

Indicates whether this IP address is the primary private IP address \n\t\t of the network interface.

\n ", + "locationName": "primary" + }, + "Association": { + "type": "structure", + "documentation": "\n\t\t

The association information for an Elastic IP address for the network interface.

\n ", + "locationName": "association", + "members": { + "PublicIp": { + "type": "string", + "documentation": "\n\t\t

The address of the Elastic IP address bound to the network interface.

\n ", + "locationName": "publicIp" + }, + "PublicDnsName": { + "type": "string", + "documentation": "\n\t\t

The public DNS name.

\n ", + "locationName": "publicDnsName" + }, + "IpOwnerId": { + "type": "string", + "documentation": "\n\t\t

The ID of the owner of the Elastic IP address.

\n ", + "locationName": "ipOwnerId" + } + } + } + } + } + } + } + } + }, + "IamInstanceProfile": { + "type": "structure", + "documentation": "\n

The IAM instance profile associated with the instance.

\n ", + "locationName": "iamInstanceProfile", + "members": { + "Arn": { + "type": "string", + "documentation": "\n

The Amazon Resource Name (ARN) of the instance profile.

\n ", + "locationName": "arn" + }, + "Id": { + "type": "string", + "documentation": "\n

The ID of the instance profile.

\n ", + "locationName": "id" + } + } + }, + "EbsOptimized": { + "type": "boolean", + "documentation": "\n

Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal I/O performance. This optimization\n\t\t\t\tisn't available with all instance types. Additional usage charges apply when\n\t\t\t\tusing an EBS Optimized instance.

\n ", + "locationName": "ebsOptimized" + }, + "SriovNetSupport": { + "type": "string", + "documentation": "\n

Specifies whether enhanced networking is enabled.

\n ", + "locationName": "sriovNetSupport" + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n

Launches the specified number of instances using an AMI for which you have permissions.

\n

When you launch an instance, it enters the pending state.\n After the instance is ready for you, it enters the running state.\n To check the state of your instance, call DescribeInstances.

\n\n

If you don't specify a security group when launching an instance, Amazon EC2 uses\n the default security group. For more information, see Security Groups\n in the Amazon Elastic Compute Cloud User Guide.

\n\n

Linux instances have access to the public key of the key pair at boot.\n You can use this key to provide secure access to the instance.\n Amazon EC2 public images use this feature to provide secure access without passwords.\n For more information, see Key Pairs\n in the Amazon Elastic Compute Cloud User Guide.

\n\n

You can provide optional user data when launching an instance. For more\n information, see Instance\n Metadata in the Amazon Elastic Compute Cloud User Guide.

\n\n\t\t

If any of the AMIs have a product code attached for which the user has not\n\t\t\tsubscribed, RunInstances fails.

\n \n

T2 instance types can only be launched into a VPC. If you do not have a\n default VPC, or if you do not specify a subnet ID in the request, RunInstances\n fails.

\n \n

For more information about troubleshooting, see What To Do If An\n Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the\n Amazon Elastic Compute Cloud User Guide.

\n\n \n \n This example launches three instances using the AMI with the ID ami-60a54009.\n https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-60a54009\n&MaxCount=3\n&MinCount=1\n&KeyName=my-key-pair\n&Placement.AvailabilityZone=us-east-1d\n&AUTHPARAMS\n \n \n This example launches an m1.small instance into a subnet.\n Because no network interface is specified, the default network interface is used.\n https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-31814f58\n&InstanceType=m1.small\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&SubnetId=subnet-b2a249da\n&AUTHPARAMS\n \n \n This example launches an m1.large instance into a subnet.\n The network interface specifies a primary private IP address of 10.0.2.106\n and two secondary private IP addresses (10.0.2.107 and 10.0.2.108).\n https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-beb0caec\n&InstanceType=m1.large\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&NetworkInterface.0.DeviceIndex=0\n&NetworkInterface.0.PrivateIpAddresses.0.Primary=true\n&NetworkInterface.0.PrivateIpAddresses.0.PrivateIpAddress=10.0.2.106\n&NetworkInterface.0.PrivateIpAddresses.1.Primary=false\n&NetworkInterface.0.PrivateIpAddresses.1.PrivateIpAddress=10.0.2.107\n&NetworkInterface.0.PrivateIpAddresses.2.Primary=false\n&NetworkInterface.0.PrivateIpAddresses.2.PrivateIpAddress=10.0.2.108\n&NetworkInterface.0.SubnetId=subnet-a61dafcf\n&AUTHPARAMS\n \n \n This example launches a Dedicated Instance into the specified subnet.\n https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-2a1fec43\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&SubnetId=subnet-dea63cb7\n&Placement.Tenancy=dedicated\n&AUTHPARAMS\n \n \n This request launches an instance into a nondefault subnet, and requests a public IP\n address for a new network interface with the device index of 0.\n https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-1a2b3c4d\n&MaxCount=1\n&MinCount=1\n&NetworkInterface.0.DeviceIndex=0\n&NetworkInterface.0.AssociatePublicIpAddress=true\n&NetworkInterface.0.SubnetId=subnet-1a2b3c4d\n&AUTHPARAMS\n \n \n This request launches an m1.large instance with a block device\n mapping. There are two instance store volumes mapped to /dev/sdc and\n /dev/sdd, and a 100 GB Amazon EBS volume mapped to\n /dev/sdf.\n https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-1a2b3c4d\n&InstanceType=m1.large\n&BlockDeviceMapping.1.DeviceName=%2Fdev%2Fsdc\n&BlockDeviceMapping.1.VirtualName=ephemeral0\n&BlockDeviceMapping.2.DeviceName=%2Fdev%2Fsdd\n&BlockDeviceMapping.2.VirtualName=ephemeral1\n&BlockDeviceMapping.3.DeviceName=%2Fdev%2Fsdf\n&BlockDeviceMapping.3.Ebs.DeleteOnTermination=false\n&BlockDeviceMapping.3.Ebs.VolumeSize=100\n&EbsOptimized=false\n&MinCount=1\n&MaxCount=1\n&DisableApiTermination=false\n&Monitoring.Enabled=false\n&AUTHPARAMS\n \n \n " + }, + "StartInstances": { + "name": "StartInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "type": "list", + "documentation": "\n

One or more instance IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + }, + "AdditionalInfo": { + "type": "string", + "documentation": "\n

Reserved.

\n " + }, + "DryRun": { + "type": "boolean", + "documentation": "\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "StartingInstances": { + "type": "list", + "documentation": "\n

Information about one or more started instances.

\n ", + "locationName": "instancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an instance state change.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "CurrentState": { + "type": "structure", + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "currentState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + }, + "PreviousState": { + "type": "structure", + "documentation": "\n

The previous state of the instance.

\n ", + "locationName": "previousState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t\t

Starts an Amazon EBS-backed AMI that you've previously stopped.

\n\t\t\t

Instances that use Amazon EBS volumes as their root devices can be quickly stopped\n\t\t\t\tand started. When an instance is stopped, the compute resources are released and you\n\t\t\t\tare not billed for hourly instance usage. However, your root partition Amazon EBS\n\t\t\t\tvolume remains, continues to persist your data, and you are charged for Amazon EBS\n\t\t\t\tvolume usage. You can restart your instance at any time. Each time you transition an\n\t\t\t\tinstance from stopped to started, Amazon EC2 charges a full instance hour, even if\n\t\t\t\ttransitions happen multiple times within a single hour.

\n\t\t\t

Before stopping an instance, make sure it is in a state from which it can\n\t\t\t\tbe restarted. Stopping an instance does not preserve data stored in RAM.

\n\t\t\t

Performing this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.

\n\t\t\t

For more information, see Stopping Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example starts the specified instance.\n https://ec2.amazonaws.com/?Action=StartInstances\n&InstanceId.1=i-10a64379\n&AUTHPARAMS\n <StartInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-10a64379</instanceId>\n <currentState>\n <code>0</code>\n <name>pending</name>\n </currentState>\n <previousState>\n <code>80</code>\n <name>stopped</name>\n </previousState>\n </item>\n </instancesSet>\n</StartInstancesResponse>\n \n \n " + }, + "StopInstances": { + "name": "StopInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceIds": { + "type": "list", + "documentation": "\n

One or more instance IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + }, + "Force": { + "type": "boolean", + "documentation": "\n

Forces the instances to stop. The instances do not have an\n\t\t\t\topportunity to flush file system caches or file system metadata. If you\n\t\t\t\tuse this option, you must perform file system check and repair\n\t\t\t\tprocedures. This option is not recommended for Windows\n\t\t\t instances.

\n

Default: false

\n " + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "StoppingInstances": { + "type": "list", + "documentation": "\n

Information about one or more stopped instances.

\n ", + "locationName": "instancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an instance state change.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "CurrentState": { + "type": "structure", + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "currentState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + }, + "PreviousState": { + "type": "structure", + "documentation": "\n

The previous state of the instance.

\n ", + "locationName": "previousState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t\t

Stops an Amazon EBS-backed instance. Each time you transition an instance from\n\t\t\t\tstopped to started, Amazon EC2 charges a full instance hour, even if transitions happen\n\t\t\t\tmultiple times within a single hour.

\n\t\t\t

You can't start or stop Spot Instances.

\n\t\t\t

Instances that use Amazon EBS volumes as their root devices can be quickly stopped\n\t\t\t\tand started. When an instance is stopped, the compute resources are released and you\n\t\t\t\tare not billed for hourly instance usage. However, your root partition Amazon EBS\n\t\t\t\tvolume remains, continues to persist your data, and you are charged for Amazon EBS\n\t\t\t\tvolume usage. You can restart your instance at any time.

\n\t\t\t

Before stopping an instance, make sure it is in a state from which it can\n\t\t\t\tbe restarted. Stopping an instance does not preserve data stored in RAM.

\n\t\t\t

Performing this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

\n

For more information about troubleshooting, see Troubleshooting\n Stopping Your Instance in the\n Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example stops the specified instance.\n https://ec2.amazonaws.com/?Action=StopInstances\n&InstanceId.1=i-10a64379\n&AUTHPARAMS\n <StopInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-10a64379</instanceId>\n <currentState>\n <code>64</code>\n <name>stopping</name>\n </currentState>\n <previousState>\n <code>16</code>\n <name>running</name>\n </previousState>\n </instancesSet>\n</StopInstancesResponse>\n \n \n " + }, + "TerminateInstances": { + "name": "TerminateInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceIds": { + "type": "list", + "documentation": "\n

One or more instance IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "TerminatingInstances": { + "type": "list", + "documentation": "\n

Information about one or more terminated instances.

\n ", + "locationName": "instancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes an instance state change.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "CurrentState": { + "type": "structure", + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "currentState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + }, + "PreviousState": { + "type": "structure", + "documentation": "\n

The previous state of the instance.

\n ", + "locationName": "previousState", + "members": { + "Code": { + "type": "integer", + "documentation": "\n

The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.

\n\t\t \n ", + "locationName": "code" + }, + "Name": { + "type": "string", + "enum": [ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ], + "documentation": "\n

The current state of the instance.

\n ", + "locationName": "name" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t\t

Shuts down one or more instances. This operation is idempotent; if you terminate\n\t\t\t\tan instance more than once, each call succeeds.

\n\t\t\t

Terminated instances remain visible after termination (for approximately one\n\t\t\t\thour).

\n\t\t\t

By default, Amazon EC2 deletes all Amazon EBS volumes that were attached\n\t\t\t\twhen the instance launched. Volumes attached after instance launch\n\t\t\t\tcontinue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

\n

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example terminates the specified instance.\n https://ec2.amazonaws.com/?Action=TerminateInstances\n&InstanceId.1=i-3ea74257\n&AUTHPARAMS\n <TerminateInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-3ea74257</instanceId>\n <currentState>\n <code>32</code>\n <name>shutting-down</name>\n </currentState>\n <previousState>\n <code>16</code>\n <name>running</name>\n </previousState>\n </item>\n </instancesSet>\n</TerminateInstancesResponse>\n \n \n " + }, + "UnassignPrivateIpAddresses": { + "name": "UnassignPrivateIpAddresses", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members": { + "NetworkInterfaceId": { + "type": "string", + "documentation": "\n\t\t

The ID of the network interface.

\n " + }, + "PrivateIpAddresses": { + "type": "list", + "documentation": "\n\t\t

The secondary private IP addresses to unassign from\n\t\t\t\tthe network interface. You can specify this option multiple times to\n\t\t\t\tunassign more than one IP address.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "PrivateIpAddress" + } + } + } + }, + "output": null, + "errors": [ + + ], + "documentation": "\n\t\t

Unassigns one or more secondary private IP addresses from a network interface.

\n \n \n Example\n The following example unassigns two secondary private IP addresses from the\n\t\t\t\t\tspecified network interface.\n https://ec2.amazonaws.com/?Action=UnassignPrivateIpAddresses\n&NetworkInterfaceId=eni-197d9972\n&PrivateIpAddress.0=10.0.2.60 \n&PrivateIpAddress.1=10.0.2.65 \n&AUTHPARAMS\n <UnassignPrivateIpAddresses xmlns=\"http://ec2.amazonaws.com/doc/2014-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</UnassignPrivateIpAddresses>\n \n \n " + }, + "UnmonitorInstances": { + "name": "UnmonitorInstances", + "input": { + "type": "structure", + "documentation": "\n ", + "required": [ + "InstanceIds" + ], + "members": { + "DryRun": { + "type": "boolean", + "documentation": "\n " + }, + "InstanceIds": { + "type": "list", + "documentation": "\n

One or more instance IDs.

\n ", + "flattened": true, + "member": { + "type": "string", + "documentation": null, + "locationName": "InstanceId" + } + } + } + }, + "output": { + "type": "structure", + "documentation": "\n ", + "members": { + "InstanceMonitorings": { + "type": "list", + "documentation": "\n

Monitoring information for one or more instances.

\n ", + "locationName": "instancesSet", + "member": { + "type": "structure", + "documentation": "\n

Describes the monitoring information of the instance.

\n ", + "locationName": "item", + "members": { + "InstanceId": { + "type": "string", + "documentation": "\n

The ID of the instance.

\n ", + "locationName": "instanceId" + }, + "Monitoring": { + "type": "structure", + "documentation": "\n

The monitoring information.

\n ", + "locationName": "monitoring", + "members": { + "State": { + "type": "string", + "enum": [ + "disabled", + "enabled", + "pending" + ], + "documentation": "\n

Indicates whether monitoring is enabled for the instance.

\n ", + "locationName": "state" + } + } + } + } + } + } + } + }, + "errors": [ + + ], + "documentation": "\n\t\t\t

Disables monitoring for a running instance. For more information about monitoring\n\t\t\t\tinstances, see Monitoring Your\n\t\t\t\tInstances and Volumes in the Amazon Elastic Compute Cloud User Guide.

\n \n \n Example\n This example disables monitoring for the specified instances.\n https://ec2.amazonaws.com/?Action=UnmonitorInstances\n&InstanceId.1=i-43a4412a\n&InstanceId.2=i-23a3397d\n&AUTHPARAMS\n <UnmonitorInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-43a4412a</instanceId>\n <monitoring>\n <state>disabled</state>\n </monitoring>\n </item>\n <item>\n <instanceId>i-23a3397d</instanceId>\n <monitoring>\n <state>disabled</state>\n </monitoring>\n </item>\n </instancesSet>\n</UnmonitorInstancesResponse>\n \n \n " + } + } +} \ No newline at end of file diff --git a/apis/ec2-2014-06-15.paginators.json b/apis/ec2-2014-06-15.paginators.json new file mode 100644 index 0000000000..bf5040c6c1 --- /dev/null +++ b/apis/ec2-2014-06-15.paginators.json @@ -0,0 +1,112 @@ +{ + "pagination": { + "DescribeAccountAttributes": { + "result_key": "AccountAttributes" + }, + "DescribeAddresses": { + "result_key": "Addresses" + }, + "DescribeAvailabilityZones": { + "result_key": "AvailabilityZones" + }, + "DescribeBundleTasks": { + "result_key": "BundleTasks" + }, + "DescribeConversionTasks": { + "result_key": "ConversionTasks" + }, + "DescribeCustomerGateways": { + "result_key": "CustomerGateways" + }, + "DescribeDhcpOptions": { + "result_key": "DhcpOptions" + }, + "DescribeExportTasks": { + "result_key": "ExportTasks" + }, + "DescribeImages": { + "result_key": "Images" + }, + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "result_key": "Reservations" + }, + "DescribeInternetGateways": { + "result_key": "InternetGateways" + }, + "DescribeKeyPairs": { + "result_key": "KeyPairs" + }, + "DescribeNetworkAcls": { + "result_key": "NetworkAcls" + }, + "DescribeNetworkInterfaces": { + "result_key": "NetworkInterfaces" + }, + "DescribePlacementGroups": { + "result_key": "PlacementGroups" + }, + "DescribeRegions": { + "result_key": "Regions" + }, + "DescribeReservedInstances": { + "result_key": "ReservedInstances" + }, + "DescribeReservedInstancesListings": { + "result_key": "ReservedInstancesListings" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeRouteTables": { + "result_key": "RouteTables" + }, + "DescribeSecurityGroups": { + "result_key": "SecurityGroups" + }, + "DescribeSnapshots": { + "result_key": "Snapshots" + }, + "DescribeSpotInstanceRequests": { + "result_key": "SpotInstanceRequests" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeSubnets": { + "result_key": "Subnets" + }, + "DescribeTags": { + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + }, + "DescribeVolumes": { + "result_key": "Volumes" + }, + "DescribeVpcs": { + "result_key": "Vpcs" + }, + "DescribeVpnConnections": { + "result_key": "VpnConnections" + }, + "DescribeVpnGateways": { + "result_key": "VpnGateways" + } + } +} diff --git a/apis/ec2-2014-06-15.waiters.json b/apis/ec2-2014-06-15.waiters.json new file mode 100644 index 0000000000..42c33a66b4 --- /dev/null +++ b/apis/ec2-2014-06-15.waiters.json @@ -0,0 +1,146 @@ +{ + "waiters": { + "__default__": { + "interval": 15, + "max_attempts": 40, + "acceptor_type": "output" + }, + "__InstanceState": { + "operation": "DescribeInstances", + "acceptor_path": "Reservations[].Instances[].State.Name" + }, + "InstanceRunning": { + "extends": "__InstanceState", + "success_value": "running", + "failure_value": [ + "shutting-down", + "terminated", + "stopping" + ] + }, + "InstanceStopped": { + "extends": "__InstanceState", + "success_value": "stopped", + "failure_value": [ + "pending", + "terminated" + ] + }, + "InstanceTerminated": { + "extends": "__InstanceState", + "success_value": "terminated", + "failure_value": [ + "pending", + "stopping" + ] + }, + "__ExportTaskState": { + "operation": "DescribeExportTasks", + "acceptor_path": "ExportTasks[].State" + }, + "ExportTaskCompleted": { + "extends": "__ExportTaskState", + "success_value": "completed" + }, + "ExportTaskCancelled": { + "extends": "__ExportTaskState", + "success_value": "cancelled" + }, + "SnapshotCompleted": { + "operation": "DescribeSnapshots", + "success_path": "Snapshots[].State", + "success_value": "completed" + }, + "SubnetAvailable": { + "operation": "DescribeSubnets", + "success_path": "Subnets[].State", + "success_value": "available" + }, + "__VolumeStatus": { + "operation": "DescribeVolumes", + "acceptor_path": "VolumeStatuses[].VolumeStatus.Status" + }, + "VolumeAvailable": { + "extends": "__VolumeStatus", + "success_value": "available", + "failure_value": [ + "deleted" + ] + }, + "VolumeInUse": { + "extends": "__VolumeStatus", + "success_value": "in-use", + "failure_value": [ + "deleted" + ] + }, + "VolumeDeleted": { + "extends": "__VolumeStatus", + "success_value": "deleted" + }, + "VpcAvailable": { + "operation": "DescribeVpcs", + "success_path": "Vpcs[].State", + "success_value": "available" + }, + "__VpnConnectionState": { + "operation": "DescribeVpnConnections", + "acceptor_path": "VpnConnections[].State" + }, + "VpnConnectionAvailable": { + "extends": "__VpnConnectionState", + "success_value": "available", + "failure_value": [ + "deleting", + "deleted" + ] + }, + "VpnConnectionDeleted": { + "extends": "__VpnConnectionState", + "success_value": "deleted", + "failure_value": [ + "pending" + ] + }, + "BundleTaskComplete": { + "operation": "DescribeBundleTasks", + "acceptor_path": "BundleTasks[].State", + "success_value": "complete", + "failure_value": [ + "failed" + ] + }, + "__ConversionTaskState": { + "operation": "DescribeConversionTasks", + "acceptor_path": "ConversionTasks[].State" + }, + "ConversionTaskCompleted": { + "extends": "__ConversionTaskState", + "success_value": "completed", + "failure_value": [ + "cancelled", + "cancelling" + ] + }, + "ConversionTaskCancelled": { + "extends": "__ConversionTaskState", + "success_value": "cancelled" + }, + "__CustomerGatewayState": { + "operation": "DescribeCustomerGateways", + "acceptor_path": "CustomerGateways[].State" + }, + "CustomerGatewayAvailable": { + "extends": "__CustomerGatewayState", + "success_value": "available", + "failure_value": [ + "deleted", + "deleting" + ] + }, + "ConversionTaskDeleted": { + "extends": "__CustomerGatewayState", + "success_value": "deleted" + } + } +} diff --git a/apis/elasticache-2014-07-15.api.json b/apis/elasticache-2014-07-15.api.json new file mode 100644 index 0000000000..177eb9dd74 --- /dev/null +++ b/apis/elasticache-2014-07-15.api.json @@ -0,0 +1,1383 @@ +{ + "metadata": { + "apiVersion": "2014-07-15", + "endpointPrefix": "elasticache", + "serviceFullName": "Amazon ElastiCache", + "signatureVersion": "v4", + "xmlNamespace": "http://elasticache.amazonaws.com/doc/2014-07-15/", + "protocol": "query" + }, + "operations": { + "AuthorizeCacheSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members": { + "CacheSecurityGroupName": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AuthorizeCacheSecurityGroupIngressResult", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape": "S4" + } + } + } + }, + "CopySnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceSnapshotName", + "TargetSnapshotName" + ], + "members": { + "SourceSnapshotName": {}, + "TargetSnapshotName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CopySnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "S9" + } + } + } + }, + "CreateCacheCluster": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId" + ], + "members": { + "CacheClusterId": {}, + "ReplicationGroupId": {}, + "NumCacheNodes": { + "type": "integer" + }, + "CacheNodeType": {}, + "Engine": {}, + "EngineVersion": {}, + "CacheParameterGroupName": {}, + "CacheSubnetGroupName": {}, + "CacheSecurityGroupNames": { + "shape": "Sg" + }, + "SecurityGroupIds": { + "shape": "Sh" + }, + "SnapshotArns": { + "type": "list", + "member": { + "locationName": "SnapshotArn" + } + }, + "SnapshotName": {}, + "AZMode": {}, + "PreferredAvailabilityZone": {}, + "PreferredAvailabilityZones": { + "shape": "Sj" + }, + "PreferredMaintenanceWindow": {}, + "Port": { + "type": "integer" + }, + "NotificationTopicArn": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateCacheClusterResult", + "type": "structure", + "members": { + "CacheCluster": { + "shape": "Sm" + } + } + } + }, + "CreateCacheParameterGroup": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName", + "CacheParameterGroupFamily", + "Description" + ], + "members": { + "CacheParameterGroupName": {}, + "CacheParameterGroupFamily": {}, + "Description": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateCacheParameterGroupResult", + "type": "structure", + "members": { + "CacheParameterGroup": { + "shape": "S11" + } + } + } + }, + "CreateCacheSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSecurityGroupName", + "Description" + ], + "members": { + "CacheSecurityGroupName": {}, + "Description": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateCacheSecurityGroupResult", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape": "S4" + } + } + } + }, + "CreateCacheSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSubnetGroupName", + "CacheSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "CacheSubnetGroupName": {}, + "CacheSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S15" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateCacheSubnetGroupResult", + "type": "structure", + "members": { + "CacheSubnetGroup": { + "shape": "S17" + } + } + } + }, + "CreateReplicationGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId", + "PrimaryClusterId", + "ReplicationGroupDescription" + ], + "members": { + "ReplicationGroupId": {}, + "PrimaryClusterId": {}, + "ReplicationGroupDescription": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateReplicationGroupResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1d" + } + } + } + }, + "CreateSnapshot": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId", + "SnapshotName" + ], + "members": { + "CacheClusterId": {}, + "SnapshotName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "S9" + } + } + } + }, + "DeleteCacheCluster": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId" + ], + "members": { + "CacheClusterId": {}, + "FinalSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteCacheClusterResult", + "type": "structure", + "members": { + "CacheCluster": { + "shape": "Sm" + } + } + } + }, + "DeleteCacheParameterGroup": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName" + ], + "members": { + "CacheParameterGroupName": {} + } + } + }, + "DeleteCacheSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSecurityGroupName" + ], + "members": { + "CacheSecurityGroupName": {} + } + } + }, + "DeleteCacheSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSubnetGroupName" + ], + "members": { + "CacheSubnetGroupName": {} + } + } + }, + "DeleteReplicationGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId" + ], + "members": { + "ReplicationGroupId": {}, + "RetainPrimaryCluster": { + "type": "boolean" + }, + "FinalSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteReplicationGroupResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1d" + } + } + } + }, + "DeleteSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotName" + ], + "members": { + "SnapshotName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "S9" + } + } + } + }, + "DescribeCacheClusters": { + "input": { + "type": "structure", + "members": { + "CacheClusterId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "ShowCacheNodeInfo": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeCacheClustersResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheClusters": { + "type": "list", + "member": { + "shape": "Sm", + "locationName": "CacheCluster" + } + } + } + } + }, + "DescribeCacheEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "CacheParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeCacheEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheEngineVersions": { + "type": "list", + "member": { + "locationName": "CacheEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "CacheParameterGroupFamily": {}, + "CacheEngineDescription": {}, + "CacheEngineVersionDescription": {} + } + } + } + } + } + }, + "DescribeCacheParameterGroups": { + "input": { + "type": "structure", + "members": { + "CacheParameterGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCacheParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheParameterGroups": { + "type": "list", + "member": { + "shape": "S11", + "locationName": "CacheParameterGroup" + } + } + } + } + }, + "DescribeCacheParameters": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName" + ], + "members": { + "CacheParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCacheParametersResult", + "type": "structure", + "members": { + "Marker": {}, + "Parameters": { + "shape": "S27" + }, + "CacheNodeTypeSpecificParameters": { + "shape": "S29" + } + } + } + }, + "DescribeCacheSecurityGroups": { + "input": { + "type": "structure", + "members": { + "CacheSecurityGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCacheSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheSecurityGroups": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "CacheSecurityGroup" + } + } + } + } + }, + "DescribeCacheSubnetGroups": { + "input": { + "type": "structure", + "members": { + "CacheSubnetGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeCacheSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "CacheSubnetGroups": { + "type": "list", + "member": { + "shape": "S17", + "locationName": "CacheSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupFamily" + ], + "members": { + "CacheParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "CacheParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S27" + }, + "CacheNodeTypeSpecificParameters": { + "shape": "S29" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeReplicationGroups": { + "input": { + "type": "structure", + "members": { + "ReplicationGroupId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReplicationGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReplicationGroups": { + "type": "list", + "member": { + "shape": "S1d", + "locationName": "ReplicationGroup" + } + } + } + } + }, + "DescribeReservedCacheNodes": { + "input": { + "type": "structure", + "members": { + "ReservedCacheNodeId": {}, + "ReservedCacheNodesOfferingId": {}, + "CacheNodeType": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedCacheNodesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedCacheNodes": { + "type": "list", + "member": { + "shape": "S2x", + "locationName": "ReservedCacheNode" + } + } + } + } + }, + "DescribeReservedCacheNodesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedCacheNodesOfferingId": {}, + "CacheNodeType": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedCacheNodesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedCacheNodesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedCacheNodesOffering", + "type": "structure", + "members": { + "ReservedCacheNodesOfferingId": {}, + "CacheNodeType": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "ProductDescription": {}, + "OfferingType": {}, + "RecurringCharges": { + "shape": "S2z" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeSnapshots": { + "input": { + "type": "structure", + "members": { + "CacheClusterId": {}, + "SnapshotName": {}, + "SnapshotSource": {}, + "Marker": {}, + "MaxRecords": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "Snapshots": { + "type": "list", + "member": { + "shape": "S9", + "locationName": "Snapshot" + } + } + } + } + }, + "ModifyCacheCluster": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId" + ], + "members": { + "CacheClusterId": {}, + "NumCacheNodes": { + "type": "integer" + }, + "CacheNodeIdsToRemove": { + "shape": "Sq" + }, + "CacheSecurityGroupNames": { + "shape": "Sg" + }, + "SecurityGroupIds": { + "shape": "Sh" + }, + "PreferredMaintenanceWindow": {}, + "NotificationTopicArn": {}, + "CacheParameterGroupName": {}, + "NotificationTopicStatus": {}, + "ApplyImmediately": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "AZMode": {}, + "NewAvailabilityZones": { + "shape": "Sj" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyCacheClusterResult", + "type": "structure", + "members": { + "CacheCluster": { + "shape": "Sm" + } + } + } + }, + "ModifyCacheParameterGroup": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName", + "ParameterNameValues" + ], + "members": { + "CacheParameterGroupName": {}, + "ParameterNameValues": { + "shape": "S3b" + } + } + }, + "output": { + "shape": "S3d", + "resultWrapper": "ModifyCacheParameterGroupResult" + } + }, + "ModifyCacheSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "CacheSubnetGroupName" + ], + "members": { + "CacheSubnetGroupName": {}, + "CacheSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S15" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyCacheSubnetGroupResult", + "type": "structure", + "members": { + "CacheSubnetGroup": { + "shape": "S17" + } + } + } + }, + "ModifyReplicationGroup": { + "input": { + "type": "structure", + "required": [ + "ReplicationGroupId" + ], + "members": { + "ReplicationGroupId": {}, + "ReplicationGroupDescription": {}, + "CacheSecurityGroupNames": { + "shape": "Sg" + }, + "SecurityGroupIds": { + "shape": "Sh" + }, + "PreferredMaintenanceWindow": {}, + "NotificationTopicArn": {}, + "CacheParameterGroupName": {}, + "NotificationTopicStatus": {}, + "ApplyImmediately": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "PrimaryClusterId": {}, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "SnapshottingClusterId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyReplicationGroupResult", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape": "S1d" + } + } + } + }, + "PurchaseReservedCacheNodesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedCacheNodesOfferingId" + ], + "members": { + "ReservedCacheNodesOfferingId": {}, + "ReservedCacheNodeId": {}, + "CacheNodeCount": { + "type": "integer" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "PurchaseReservedCacheNodesOfferingResult", + "type": "structure", + "members": { + "ReservedCacheNode": { + "shape": "S2x" + } + } + } + }, + "RebootCacheCluster": { + "input": { + "type": "structure", + "required": [ + "CacheClusterId", + "CacheNodeIdsToReboot" + ], + "members": { + "CacheClusterId": {}, + "CacheNodeIdsToReboot": { + "shape": "Sq" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RebootCacheClusterResult", + "type": "structure", + "members": { + "CacheCluster": { + "shape": "Sm" + } + } + } + }, + "ResetCacheParameterGroup": { + "input": { + "type": "structure", + "required": [ + "CacheParameterGroupName", + "ParameterNameValues" + ], + "members": { + "CacheParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "ParameterNameValues": { + "shape": "S3b" + } + } + }, + "output": { + "shape": "S3d", + "resultWrapper": "ResetCacheParameterGroupResult" + } + }, + "RevokeCacheSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members": { + "CacheSecurityGroupName": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RevokeCacheSecurityGroupIngressResult", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape": "S4" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "OwnerId": {}, + "CacheSecurityGroupName": {}, + "Description": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + } + } + }, + "wrapper": true + }, + "S9": { + "type": "structure", + "members": { + "SnapshotName": {}, + "CacheClusterId": {}, + "SnapshotStatus": {}, + "SnapshotSource": {}, + "CacheNodeType": {}, + "Engine": {}, + "EngineVersion": {}, + "NumCacheNodes": { + "type": "integer" + }, + "PreferredAvailabilityZone": {}, + "CacheClusterCreateTime": { + "type": "timestamp" + }, + "PreferredMaintenanceWindow": {}, + "TopicArn": {}, + "Port": { + "type": "integer" + }, + "CacheParameterGroupName": {}, + "CacheSubnetGroupName": {}, + "VpcId": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {}, + "NodeSnapshots": { + "type": "list", + "member": { + "locationName": "NodeSnapshot", + "type": "structure", + "members": { + "CacheNodeId": {}, + "CacheSize": {}, + "CacheNodeCreateTime": { + "type": "timestamp" + }, + "SnapshotCreateTime": { + "type": "timestamp" + } + }, + "wrapper": true + } + } + }, + "wrapper": true + }, + "Sg": { + "type": "list", + "member": { + "locationName": "CacheSecurityGroupName" + } + }, + "Sh": { + "type": "list", + "member": { + "locationName": "SecurityGroupId" + } + }, + "Sj": { + "type": "list", + "member": { + "locationName": "PreferredAvailabilityZone" + } + }, + "Sm": { + "type": "structure", + "members": { + "CacheClusterId": {}, + "ConfigurationEndpoint": { + "shape": "Sn" + }, + "ClientDownloadLandingPage": {}, + "CacheNodeType": {}, + "Engine": {}, + "EngineVersion": {}, + "CacheClusterStatus": {}, + "NumCacheNodes": { + "type": "integer" + }, + "PreferredAvailabilityZone": {}, + "CacheClusterCreateTime": { + "type": "timestamp" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "NumCacheNodes": { + "type": "integer" + }, + "CacheNodeIdsToRemove": { + "shape": "Sq" + }, + "EngineVersion": {} + } + }, + "NotificationConfiguration": { + "type": "structure", + "members": { + "TopicArn": {}, + "TopicStatus": {} + } + }, + "CacheSecurityGroups": { + "type": "list", + "member": { + "locationName": "CacheSecurityGroup", + "type": "structure", + "members": { + "CacheSecurityGroupName": {}, + "Status": {} + } + } + }, + "CacheParameterGroup": { + "type": "structure", + "members": { + "CacheParameterGroupName": {}, + "ParameterApplyStatus": {}, + "CacheNodeIdsToReboot": { + "shape": "Sq" + } + } + }, + "CacheSubnetGroupName": {}, + "CacheNodes": { + "type": "list", + "member": { + "locationName": "CacheNode", + "type": "structure", + "members": { + "CacheNodeId": {}, + "CacheNodeStatus": {}, + "CacheNodeCreateTime": { + "type": "timestamp" + }, + "Endpoint": { + "shape": "Sn" + }, + "ParameterGroupStatus": {}, + "SourceCacheNodeId": {}, + "CustomerAvailabilityZone": {} + } + } + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "SecurityGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SecurityGroupId": {}, + "Status": {} + } + } + }, + "ReplicationGroupId": {}, + "SnapshotRetentionLimit": { + "type": "integer" + }, + "SnapshotWindow": {} + }, + "wrapper": true + }, + "Sn": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "Sq": { + "type": "list", + "member": { + "locationName": "CacheNodeId" + } + }, + "S11": { + "type": "structure", + "members": { + "CacheParameterGroupName": {}, + "CacheParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S15": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S17": { + "type": "structure", + "members": { + "CacheSubnetGroupName": {}, + "CacheSubnetGroupDescription": {}, + "VpcId": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "type": "structure", + "members": { + "Name": {} + }, + "wrapper": true + } + } + } + } + }, + "wrapper": true + }, + "S1d": { + "type": "structure", + "members": { + "ReplicationGroupId": {}, + "Description": {}, + "Status": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "PrimaryClusterId": {} + } + }, + "MemberClusters": { + "type": "list", + "member": { + "locationName": "ClusterId" + } + }, + "NodeGroups": { + "type": "list", + "member": { + "locationName": "NodeGroup", + "type": "structure", + "members": { + "NodeGroupId": {}, + "Status": {}, + "PrimaryEndpoint": { + "shape": "Sn" + }, + "NodeGroupMembers": { + "type": "list", + "member": { + "locationName": "NodeGroupMember", + "type": "structure", + "members": { + "CacheClusterId": {}, + "CacheNodeId": {}, + "ReadEndpoint": { + "shape": "Sn" + }, + "PreferredAvailabilityZone": {}, + "CurrentRole": {} + } + } + } + } + } + }, + "SnapshottingClusterId": {} + }, + "wrapper": true + }, + "S27": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {} + } + } + }, + "S29": { + "type": "list", + "member": { + "locationName": "CacheNodeTypeSpecificParameter", + "type": "structure", + "members": { + "ParameterName": {}, + "Description": {}, + "Source": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "CacheNodeTypeSpecificValues": { + "type": "list", + "member": { + "locationName": "CacheNodeTypeSpecificValue", + "type": "structure", + "members": { + "CacheNodeType": {}, + "Value": {} + } + } + } + } + } + }, + "S2x": { + "type": "structure", + "members": { + "ReservedCacheNodeId": {}, + "ReservedCacheNodesOfferingId": {}, + "CacheNodeType": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CacheNodeCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "State": {}, + "RecurringCharges": { + "shape": "S2z" + } + }, + "wrapper": true + }, + "S2z": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S3b": { + "type": "list", + "member": { + "locationName": "ParameterNameValue", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {} + } + } + }, + "S3d": { + "type": "structure", + "members": { + "CacheParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/apis/elasticache-2014-07-15.full.json b/apis/elasticache-2014-07-15.full.json new file mode 100644 index 0000000000..7e43b07995 --- /dev/null +++ b/apis/elasticache-2014-07-15.full.json @@ -0,0 +1,4826 @@ +{ + "metadata":{ + "apiVersion":"2014-07-15", + "endpointPrefix":"elasticache", + "serviceFullName":"Amazon ElastiCache", + "signatureVersion":"v4", + "xmlNamespace":"http://elasticache.amazonaws.com/doc/2014-07-15/", + "protocol":"query" + }, + "documentation":"Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes set-up, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

", + "operations":{ + "AuthorizeCacheSecurityGroupIngress":{ + "name":"AuthorizeCacheSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AuthorizeCacheSecurityGroupIngressMessage", + "documentation":"

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

" + }, + "output":{ + "shape":"AuthorizeCacheSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

", + "resultWrapper":"AuthorizeCacheSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"AuthorizationAlreadyExistsFault", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon EC2 security group is already authorized for the specified cache security group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopySnapshotMessage", + "documentation":"

Represents the input of a CopySnapshotMessage operation.

" + }, + "output":{ + "shape":"CopySnapshotResult", + "wrapper":true, + "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", + "resultWrapper":"CopySnapshotResult" + }, + "errors":[ + { + "shape":"SnapshotAlreadyExistsFault", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + { + "shape":"SnapshotNotFoundFault", + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + { + "shape":"InvalidSnapshotStateFault", + "error":{ + "code":"InvalidSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CopySnapshot operation makes a copy of an existing snapshot.

" + }, + "CreateCacheCluster":{ + "name":"CreateCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateCacheClusterMessage", + "documentation":"

Represents the input of a CreateCacheCluster operation.

" + }, + "output":{ + "shape":"CreateCacheClusterResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

", + "resultWrapper":"CreateCacheClusterResult" + }, + "errors":[ + { + "shape":"ReplicationGroupNotFoundFault", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + { + "shape":"InvalidReplicationGroupStateFault", + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested replication group is not in the available state.

" + }, + { + "shape":"CacheClusterAlreadyExistsFault", + "error":{ + "code":"CacheClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a cache cluster with the given identifier.

" + }, + { + "shape":"InsufficientCacheClusterCapacityFault", + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + }, + { + "shape":"ClusterQuotaForCustomerExceededFault", + "error":{ + "code":"ClusterQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

" + }, + { + "shape":"NodeQuotaForClusterExceededFault", + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" + }, + { + "shape":"NodeQuotaForCustomerExceededFault", + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CreateCacheCluster operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.

" + }, + "CreateCacheParameterGroup":{ + "name":"CreateCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateCacheParameterGroupMessage", + "documentation":"

Represents the input of a CreateCacheParameterGroup operation.

" + }, + "output":{ + "shape":"CreateCacheParameterGroupResult", + "wrapper":true, + "documentation":"

Represents the output of a CreateCacheParameterGroup operation.

", + "resultWrapper":"CreateCacheParameterGroupResult" + }, + "errors":[ + { + "shape":"CacheParameterGroupQuotaExceededFault", + "error":{ + "code":"CacheParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of cache security groups.

" + }, + { + "shape":"CacheParameterGroupAlreadyExistsFault", + "error":{ + "code":"CacheParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A cache parameter group with the requested name already exists.

" + }, + { + "shape":"InvalidCacheParameterGroupStateFault", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CreateCacheParameterGroup operation creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.

" + }, + "CreateCacheSecurityGroup":{ + "name":"CreateCacheSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateCacheSecurityGroupMessage", + "documentation":"

Represents the input of a CreateCacheSecurityGroup operation.

" + }, + "output":{ + "shape":"CreateCacheSecurityGroupResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

", + "resultWrapper":"CreateCacheSecurityGroupResult" + }, + "errors":[ + { + "shape":"CacheSecurityGroupAlreadyExistsFault", + "error":{ + "code":"CacheSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A cache security group with the specified name already exists.

" + }, + { + "shape":"CacheSecurityGroupQuotaExceededFault", + "error":{ + "code":"QuotaExceeded.CacheSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache security groups.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CreateCacheSecurityGroup operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

" + }, + "CreateCacheSubnetGroup":{ + "name":"CreateCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateCacheSubnetGroupMessage", + "documentation":"

Represents the input of a CreateCacheSubnetGroup operation.

" + }, + "output":{ + "shape":"CreateCacheSubnetGroupResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

", + "resultWrapper":"CreateCacheSubnetGroupResult" + }, + "errors":[ + { + "shape":"CacheSubnetGroupAlreadyExistsFault", + "error":{ + "code":"CacheSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name is already in use by an existing cache subnet group.

" + }, + { + "shape":"CacheSubnetGroupQuotaExceededFault", + "error":{ + "code":"CacheSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

" + }, + { + "shape":"CacheSubnetQuotaExceededFault", + "error":{ + "code":"CacheSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

An invalid subnet identifier was specified.

" + } + ], + "documentation":"

The CreateCacheSubnetGroup operation creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

" + }, + "CreateReplicationGroup":{ + "name":"CreateReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateReplicationGroupMessage", + "documentation":"

Represents the input of a CreateReplicationGroup operation.

" + }, + "output":{ + "shape":"CreateReplicationGroupResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific replication group.

", + "resultWrapper":"CreateReplicationGroupResult" + }, + "errors":[ + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"ReplicationGroupAlreadyExistsFault", + "error":{ + "code":"ReplicationGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group already exists.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CreateReplicationGroup operation creates a replication group. A replication group is a collection of cache clusters, where one of the clusters is a read/write primary and the other clusters are read-only replicas. Writes to the primary are automatically propagated to the replicas.

When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateSnapshotMessage", + "documentation":"

Represents the input of a CreateSnapshotMessage operation.

" + }, + "output":{ + "shape":"CreateSnapshotResult", + "wrapper":true, + "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", + "resultWrapper":"CreateSnapshotResult" + }, + "errors":[ + { + "shape":"SnapshotAlreadyExistsFault", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + { + "shape":"SnapshotFeatureNotSupportedFault", + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You attempted one of the following actions:

Neither of these are supported by ElastiCache.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + } + ], + "documentation":"

The CreateSnapshot operation creates a copy of an entire cache cluster at a specific moment in time.

" + }, + "DeleteCacheCluster":{ + "name":"DeleteCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteCacheClusterMessage", + "documentation":"

Represents the input of a DeleteCacheCluster operation.

" + }, + "output":{ + "shape":"DeleteCacheClusterResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

", + "resultWrapper":"DeleteCacheClusterResult" + }, + "errors":[ + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"SnapshotAlreadyExistsFault", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + { + "shape":"SnapshotFeatureNotSupportedFault", + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You attempted one of the following actions:

Neither of these are supported by ElastiCache.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteCacheCluster operation deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.

" + }, + "DeleteCacheParameterGroup":{ + "name":"DeleteCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteCacheParameterGroupMessage", + "documentation":"

Represents the input of a DeleteCacheParameterGroup operation.

" + }, + "errors":[ + { + "shape":"InvalidCacheParameterGroupStateFault", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteCacheParameterGroup operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.

" + }, + "DeleteCacheSecurityGroup":{ + "name":"DeleteCacheSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteCacheSecurityGroupMessage", + "documentation":"

Represents the input of a DeleteCacheSecurityGroup operation.

" + }, + "errors":[ + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteCacheSecurityGroup operation deletes a cache security group.

" + }, + "DeleteCacheSubnetGroup":{ + "name":"DeleteCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteCacheSubnetGroupMessage", + "documentation":"

Represents the input of a DeleteCacheSubnetGroup operation.

" + }, + "errors":[ + { + "shape":"CacheSubnetGroupInUse", + "error":{ + "code":"CacheSubnetGroupInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group is currently in use.

" + }, + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + } + ], + "documentation":"

The DeleteCacheSubnetGroup operation deletes a cache subnet group.

" + }, + "DeleteReplicationGroup":{ + "name":"DeleteReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteReplicationGroupMessage", + "documentation":"

Represents the input of a DeleteReplicationGroup operation.

" + }, + "output":{ + "shape":"DeleteReplicationGroupResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific replication group.

", + "resultWrapper":"DeleteReplicationGroupResult" + }, + "errors":[ + { + "shape":"ReplicationGroupNotFoundFault", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + { + "shape":"InvalidReplicationGroupStateFault", + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested replication group is not in the available state.

" + }, + { + "shape":"SnapshotAlreadyExistsFault", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + { + "shape":"SnapshotFeatureNotSupportedFault", + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You attempted one of the following actions:

Neither of these are supported by ElastiCache.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteReplicationGroup operation deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary cache cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cache cluster.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteSnapshotMessage", + "documentation":"

Represents the input of a DeleteSnapshotMessage operation.

" + }, + "output":{ + "shape":"DeleteSnapshotResult", + "wrapper":true, + "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", + "resultWrapper":"DeleteSnapshotResult" + }, + "errors":[ + { + "shape":"SnapshotNotFoundFault", + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" + }, + { + "shape":"InvalidSnapshotStateFault", + "error":{ + "code":"InvalidSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteSnapshot operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

" + }, + "DescribeCacheClusters":{ + "name":"DescribeCacheClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheClustersMessage", + "documentation":"

Represents the input of a DescribeCacheClusters operation.

" + }, + "output":{ + "shape":"CacheClusterMessage", + "documentation":"

Represents the output of a DescribeCacheClusters operation.

", + "resultWrapper":"DescribeCacheClustersResult" + }, + "errors":[ + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeCacheClusters operation returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

" + }, + "DescribeCacheEngineVersions":{ + "name":"DescribeCacheEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheEngineVersionsMessage", + "documentation":"

Represents the input of a DescribeCacheEngineVersions operation.

" + }, + "output":{ + "shape":"CacheEngineVersionMessage", + "documentation":"

Represents the output of a DescribeCacheEngineVersions operation.

", + "resultWrapper":"DescribeCacheEngineVersionsResult" + }, + "documentation":"

The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.

" + }, + "DescribeCacheParameterGroups":{ + "name":"DescribeCacheParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheParameterGroupsMessage", + "documentation":"

Represents the input of a DescribeCacheParameterGroups operation.

" + }, + "output":{ + "shape":"CacheParameterGroupsMessage", + "documentation":"

Represents the output of a DescribeCacheParameterGroups operation.

", + "resultWrapper":"DescribeCacheParameterGroupsResult" + }, + "errors":[ + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeCacheParameterGroups operation returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.

" + }, + "DescribeCacheParameters":{ + "name":"DescribeCacheParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheParametersMessage", + "documentation":"

Represents the input of a DescribeCacheParameters operation.

" + }, + "output":{ + "shape":"CacheParameterGroupDetails", + "documentation":"

Represents the output of a DescribeCacheParameters operation.

", + "resultWrapper":"DescribeCacheParametersResult" + }, + "errors":[ + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.

" + }, + "DescribeCacheSecurityGroups":{ + "name":"DescribeCacheSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheSecurityGroupsMessage", + "documentation":"

Represents the input of a DescribeCacheSecurityGroups operation.

" + }, + "output":{ + "shape":"CacheSecurityGroupMessage", + "documentation":"

Represents the output of a DescribeCacheSecurityGroups operation.

", + "resultWrapper":"DescribeCacheSecurityGroupsResult" + }, + "errors":[ + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeCacheSecurityGroups operation returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.

" + }, + "DescribeCacheSubnetGroups":{ + "name":"DescribeCacheSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheSubnetGroupsMessage", + "documentation":"

Represents the input of a DescribeCacheSubnetGroups operation.

" + }, + "output":{ + "shape":"CacheSubnetGroupMessage", + "documentation":"

Represents the output of a DescribeCacheSubnetGroups operation.

", + "resultWrapper":"DescribeCacheSubnetGroupsResult" + }, + "errors":[ + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + } + ], + "documentation":"

The DescribeCacheSubnetGroups operation returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

" + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEngineDefaultParametersMessage", + "documentation":"

Represents the input of a DescribeEngineDefaultParameters operation.

" + }, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "wrapper":true, + "documentation":"

Represents the output of a DescribeEngineDefaultParameters operation.

", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeEngineDefaultParameters operation returns the default engine and system parameter information for the specified cache engine.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventsMessage", + "documentation":"

Represents the input of a DescribeEvents operation.

" + }, + "output":{ + "shape":"EventsMessage", + "documentation":"

Represents the output of a DescribeEvents operation.

", + "resultWrapper":"DescribeEventsResult" + }, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

" + }, + "DescribeReplicationGroups":{ + "name":"DescribeReplicationGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReplicationGroupsMessage", + "documentation":"

Represents the input of a DescribeReplicationGroups operation.

" + }, + "output":{ + "shape":"ReplicationGroupMessage", + "documentation":"

Represents the output of a DescribeReplicationGroups operation.

", + "resultWrapper":"DescribeReplicationGroupsResult" + }, + "errors":[ + { + "shape":"ReplicationGroupNotFoundFault", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeReplicationGroups operation returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

" + }, + "DescribeReservedCacheNodes":{ + "name":"DescribeReservedCacheNodes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedCacheNodesMessage", + "documentation":"

Represents the input of a DescribeReservedCacheNodes operation.

" + }, + "output":{ + "shape":"ReservedCacheNodeMessage", + "documentation":"

Represents the output of a DescribeReservedCacheNodes operation.

", + "resultWrapper":"DescribeReservedCacheNodesResult" + }, + "errors":[ + { + "shape":"ReservedCacheNodeNotFoundFault", + "error":{ + "code":"ReservedCacheNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested reserved cache node was not found.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.

" + }, + "DescribeReservedCacheNodesOfferings":{ + "name":"DescribeReservedCacheNodesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedCacheNodesOfferingsMessage", + "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" + }, + "output":{ + "shape":"ReservedCacheNodesOfferingMessage", + "documentation":"

Represents the output of a DescribeReservedCacheNodesOfferings operation.

", + "resultWrapper":"DescribeReservedCacheNodesOfferingsResult" + }, + "errors":[ + { + "shape":"ReservedCacheNodesOfferingNotFoundFault", + "error":{ + "code":"ReservedCacheNodesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node offering does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSnapshotsMessage", + "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" + }, + "output":{ + "shape":"DescribeSnapshotsListMessage", + "documentation":"

Represents the output of a DescribeSnapshots operation.

", + "resultWrapper":"DescribeSnapshotsResult" + }, + "errors":[ + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"SnapshotNotFoundFault", + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeSnapshots operation returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

" + }, + "ModifyCacheCluster":{ + "name":"ModifyCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyCacheClusterMessage", + "documentation":"

Represents the input of a ModifyCacheCluster operation.

" + }, + "output":{ + "shape":"ModifyCacheClusterResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

", + "resultWrapper":"ModifyCacheClusterResult" + }, + "errors":[ + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"InsufficientCacheClusterCapacityFault", + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" + }, + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"NodeQuotaForClusterExceededFault", + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" + }, + { + "shape":"NodeQuotaForCustomerExceededFault", + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The ModifyCacheCluster operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

" + }, + "ModifyCacheParameterGroup":{ + "name":"ModifyCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyCacheParameterGroupMessage", + "documentation":"

Represents the input of a ModifyCacheParameterGroup operation.

" + }, + "output":{ + "shape":"CacheParameterGroupNameMessage", + "documentation":"

Represents the output of one of the following operations:

", + "resultWrapper":"ModifyCacheParameterGroupResult" + }, + "errors":[ + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidCacheParameterGroupStateFault", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The ModifyCacheParameterGroup operation modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

" + }, + "ModifyCacheSubnetGroup":{ + "name":"ModifyCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyCacheSubnetGroupMessage", + "documentation":"

Represents the input of a ModifyCacheSubnetGroup operation.

" + }, + "output":{ + "shape":"ModifyCacheSubnetGroupResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

", + "resultWrapper":"ModifyCacheSubnetGroupResult" + }, + "errors":[ + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + }, + { + "shape":"CacheSubnetQuotaExceededFault", + "error":{ + "code":"CacheSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" + }, + { + "shape":"SubnetInUse", + "error":{ + "code":"SubnetInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is being used by another cache subnet group.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

An invalid subnet identifier was specified.

" + } + ], + "documentation":"

The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.

" + }, + "ModifyReplicationGroup":{ + "name":"ModifyReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyReplicationGroupMessage", + "documentation":"

Represents the input of a ModifyReplicationGroups operation.

" + }, + "output":{ + "shape":"ModifyReplicationGroupResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific replication group.

", + "resultWrapper":"ModifyReplicationGroupResult" + }, + "errors":[ + { + "shape":"ReplicationGroupNotFoundFault", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + { + "shape":"InvalidReplicationGroupStateFault", + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested replication group is not in the available state.

" + }, + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The ModifyReplicationGroup operation modifies the settings for a replication group.

" + }, + "PurchaseReservedCacheNodesOffering":{ + "name":"PurchaseReservedCacheNodesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PurchaseReservedCacheNodesOfferingMessage", + "documentation":"

Represents the input of a PurchaseReservedCacheNodesOffering operation.

" + }, + "output":{ + "shape":"PurchaseReservedCacheNodesOfferingResult", + "wrapper":true, + "documentation":"

Represents the output of a PurchaseReservedCacheNodesOffering operation.

", + "resultWrapper":"PurchaseReservedCacheNodesOfferingResult" + }, + "errors":[ + { + "shape":"ReservedCacheNodesOfferingNotFoundFault", + "error":{ + "code":"ReservedCacheNodesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node offering does not exist.

" + }, + { + "shape":"ReservedCacheNodeAlreadyExistsFault", + "error":{ + "code":"ReservedCacheNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a reservation with the given identifier.

" + }, + { + "shape":"ReservedCacheNodeQuotaExceededFault", + "error":{ + "code":"ReservedCacheNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the user's cache node quota.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.

" + }, + "RebootCacheCluster":{ + "name":"RebootCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RebootCacheClusterMessage", + "documentation":"

Represents the input of a RebootCacheCluster operation.

" + }, + "output":{ + "shape":"RebootCacheClusterResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

", + "resultWrapper":"RebootCacheClusterResult" + }, + "errors":[ + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + } + ], + "documentation":"

The RebootCacheCluster operation reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cache cluster event is created.

" + }, + "ResetCacheParameterGroup":{ + "name":"ResetCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ResetCacheParameterGroupMessage", + "documentation":"

Represents the input of a ResetCacheParameterGroup operation.

" + }, + "output":{ + "shape":"CacheParameterGroupNameMessage", + "documentation":"

Represents the output of one of the following operations:

", + "resultWrapper":"ResetCacheParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidCacheParameterGroupStateFault", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The ResetCacheParameterGroup operation modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

" + }, + "RevokeCacheSecurityGroupIngress":{ + "name":"RevokeCacheSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RevokeCacheSecurityGroupIngressMessage", + "documentation":"

Represents the input of a RevokeCacheSecurityGroupIngress operation.

" + }, + "output":{ + "shape":"RevokeCacheSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

", + "resultWrapper":"RevokeCacheSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon EC2 security group is not authorized for the specified cache security group.

" + }, + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

" + } + }, + "shapes":{ + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon EC2 security group is already authorized for the specified cache security group.

" + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon EC2 security group is not authorized for the specified cache security group.

" + }, + "AuthorizeCacheSecurityGroupIngressMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The cache security group which will allow network ingress.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The Amazon EC2 security group to be authorized for ingress to the cache security group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" + } + }, + "documentation":"

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

" + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

" + } + }, + "wrapper":true, + "documentation":"

Describes an Availability Zone in which the cache cluster is launched.

" + }, + "AwsQueryErrorMessage":{"type":"string"}, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CacheCluster":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied identifier of the cache cluster. This is a unique key that identifies a cache cluster.

" + }, + "ConfigurationEndpoint":{"shape":"Endpoint"}, + "ClientDownloadLandingPage":{ + "shape":"String", + "documentation":"

The URL of the web page where you can download the latest ElastiCache client library.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The name of the compute and memory capacity node type for the cache cluster.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine (memcached or redis) to be used for this cache cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the cache engine version that is used in this cache cluster.

" + }, + "CacheClusterStatus":{ + "shape":"String", + "documentation":"

The current state of this cache cluster - creating, available, etc.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes in the cache cluster.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the cache cluster is located or \"Multiple\" if the cache nodes are located in different Availability Zones.

" + }, + "CacheClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cache cluster was created.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The time range (in UTC) during which weekly system maintenance can occur.

" + }, + "PendingModifiedValues":{"shape":"PendingModifiedValues"}, + "NotificationConfiguration":{"shape":"NotificationConfiguration"}, + "CacheSecurityGroups":{ + "shape":"CacheSecurityGroupMembershipList", + "documentation":"

A list of cache security group elements, composed of name and status sub-elements.

" + }, + "CacheParameterGroup":{"shape":"CacheParameterGroupStatus"}, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group associated with the cache cluster.

" + }, + "CacheNodes":{ + "shape":"CacheNodeList", + "documentation":"

A list of cache nodes that are members of the cache cluster.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

If true, then minor version patches are applied automatically; if false, then automatic minor version patches are disabled.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupMembershipList", + "documentation":"

A list of VPC Security Groups associated with the cache cluster.

" + }, + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Example: 05:00-09:00

" + } + }, + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

" + }, + "CacheClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a cache cluster with the given identifier.

" + }, + "CacheClusterList":{ + "type":"list", + "member":{ + "shape":"CacheCluster", + "locationName":"CacheCluster" + } + }, + "CacheClusterMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheClusters":{ + "shape":"CacheClusterList", + "documentation":"

A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheClusters operation.

" + }, + "CacheClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + "CacheEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the cache engine.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family associated with this cache engine.

" + }, + "CacheEngineDescription":{ + "shape":"String", + "documentation":"

The description of the cache engine.

" + }, + "CacheEngineVersionDescription":{ + "shape":"String", + "documentation":"

The description of the cache engine version.

" + } + }, + "documentation":"

Provides all of the details about a particular cache engine version.

" + }, + "CacheEngineVersionList":{ + "type":"list", + "member":{ + "shape":"CacheEngineVersion", + "locationName":"CacheEngineVersion" + } + }, + "CacheEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheEngineVersions":{ + "shape":"CacheEngineVersionList", + "documentation":"

A list of cache engine version details. Each element in the list contains detailed information about once cache engine version.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheEngineVersions operation.

" + }, + "CacheNode":{ + "type":"structure", + "members":{ + "CacheNodeId":{ + "shape":"String", + "documentation":"

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

" + }, + "CacheNodeStatus":{ + "shape":"String", + "documentation":"

The current state of this cache node.

" + }, + "CacheNodeCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cache node was created.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The hostname and IP address for connecting to this cache node.

" + }, + "ParameterGroupStatus":{ + "shape":"String", + "documentation":"

The status of the parameter group applied to this cache node.

" + }, + "SourceCacheNodeId":{ + "shape":"String", + "documentation":"

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

" + }, + "CustomerAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where this node was created and now resides.

" + } + }, + "documentation":"

Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

" + }, + "CacheNodeIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CacheNodeId" + } + }, + "CacheNodeList":{ + "type":"list", + "member":{ + "shape":"CacheNode", + "locationName":"CacheNode" + } + }, + "CacheNodeTypeSpecificParameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source of the parameter value.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

The valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest cache engine version to which the parameter can apply.

" + }, + "CacheNodeTypeSpecificValues":{ + "shape":"CacheNodeTypeSpecificValueList", + "documentation":"

A list of cache node types and their corresponding values for this parameter.

" + } + }, + "documentation":"

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

" + }, + "CacheNodeTypeSpecificParametersList":{ + "type":"list", + "member":{ + "shape":"CacheNodeTypeSpecificParameter", + "locationName":"CacheNodeTypeSpecificParameter" + } + }, + "CacheNodeTypeSpecificValue":{ + "type":"structure", + "members":{ + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for which this value applies.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value for the cache node type.

" + } + }, + "documentation":"

A value that applies only to a certain cache node type.

" + }, + "CacheNodeTypeSpecificValueList":{ + "type":"list", + "member":{ + "shape":"CacheNodeTypeSpecificValue", + "locationName":"CacheNodeTypeSpecificValue" + } + }, + "CacheParameterGroup":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family that this cache parameter group is compatible with.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for this cache parameter group.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of a CreateCacheParameterGroup operation.

" + }, + "CacheParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A cache parameter group with the requested name already exists.

" + }, + "CacheParameterGroupDetails":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of Parameter instances.

" + }, + "CacheNodeTypeSpecificParameters":{ + "shape":"CacheNodeTypeSpecificParametersList", + "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheParameters operation.

" + }, + "CacheParameterGroupList":{ + "type":"list", + "member":{ + "shape":"CacheParameterGroup", + "locationName":"CacheParameterGroup" + } + }, + "CacheParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + } + }, + "documentation":"

Represents the output of one of the following operations:

" + }, + "CacheParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + "CacheParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of cache security groups.

" + }, + "CacheParameterGroupStatus":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

The status of parameter updates.

" + }, + "CacheNodeIdsToReboot":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

" + } + }, + "documentation":"

The status of the cache parameter group.

" + }, + "CacheParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheParameterGroups":{ + "shape":"CacheParameterGroupList", + "documentation":"

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheParameterGroups operation.

" + }, + "CacheSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the cache security group owner.

" + }, + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the cache security group.

" + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

A list of Amazon EC2 security groups that are associated with this cache security group.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

" + }, + "CacheSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A cache security group with the specified name already exists.

" + }, + "CacheSecurityGroupMembership":{ + "type":"structure", + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

" + } + }, + "documentation":"

Represents a cache cluster's status within a particular cache security group.

" + }, + "CacheSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"CacheSecurityGroupMembership", + "locationName":"CacheSecurityGroup" + } + }, + "CacheSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheSecurityGroups":{ + "shape":"CacheSecurityGroups", + "documentation":"

A list of cache security groups. Each element in the list contains detailed information about one group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheSecurityGroups operation.

" + }, + "CacheSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CacheSecurityGroupName" + } + }, + "CacheSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + "CacheSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.CacheSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache security groups.

" + }, + "CacheSecurityGroups":{ + "type":"list", + "member":{ + "shape":"CacheSecurityGroup", + "locationName":"CacheSecurityGroup" + } + }, + "CacheSubnetGroup":{ + "type":"structure", + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group.

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description of the cache subnet group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

A list of subnets associated with the cache subnet group.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

" + }, + "CacheSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name is already in use by an existing cache subnet group.

" + }, + "CacheSubnetGroupInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetGroupInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group is currently in use.

" + }, + "CacheSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheSubnetGroups":{ + "shape":"CacheSubnetGroups", + "documentation":"

A list of cache subnet groups. Each element in the list contains detailed information about one group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheSubnetGroups operation.

" + }, + "CacheSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + }, + "CacheSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

" + }, + "CacheSubnetGroups":{ + "type":"list", + "member":{ + "shape":"CacheSubnetGroup", + "locationName":"CacheSubnetGroup" + } + }, + "CacheSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" + }, + "ClusterIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ClusterId" + } + }, + "ClusterQuotaForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

" + }, + "CopySnapshotMessage":{ + "type":"structure", + "required":[ + "SourceSnapshotName", + "TargetSnapshotName" + ], + "members":{ + "SourceSnapshotName":{ + "shape":"String", + "documentation":"

The name of an existing snapshot from which to copy.

" + }, + "TargetSnapshotName":{ + "shape":"String", + "documentation":"

A name for the copied snapshot.

" + } + }, + "documentation":"

Represents the input of a CopySnapshotMessage operation.

" + }, + "CreateCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster identifier. This parameter is stored as a lowercase string.

Constraints:

" + }, + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The initial number of cache nodes that the cache cluster will have.

For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .

For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the nodes in the cache cluster.

Valid cache types

For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine to be used for this cache cluster.

Valid values for this parameter are:

memcached | redis

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to be used for the cache cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to associate with this cache cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

One or more VPC security groups associated with the cache cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

" + }, + "SnapshotArns":{ + "shape":"SnapshotArnsList", + "documentation":"

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Note: This parameter is only valid if the Engine parameter is redis.

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of a snapshot from which to restore data into the new cache cluster. The snapshot's status changes to restoring while the new cache cluster is being created.

" + }, + "AZMode":{ + "shape":"String", + "documentation":"

Specifies whether the nodes in this Memcached cache cluster are created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone in which the cache cluster will be created.

All cache nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your cache nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

" + }, + "PreferredAvailabilityZones":{ + "shape":"PreferredAvailabilityZoneList", + "documentation":"

A list of the Availability Zones in which nodes will be created. The order of the zones in the list is not important.

This option is only supported on Memcached clusters.

If you want all your cache nodes in the same Availability Zone, use PreferredAvailabilityZone instead or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Example: One Memcached node in each of three Availability Zones: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which each of the cache nodes will accept connections.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

" + } + }, + "documentation":"

Represents the input of a CreateCacheCluster operation.

" + }, + "CreateCacheParameterGroupMessage":{ + "type":"structure", + "required":[ + "CacheParameterGroupName", + "CacheParameterGroupFamily", + "Description" + ], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

A user-specified name for the cache parameter group.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family the cache parameter group can be used with.

Valid values are: memcached1.4 | redis2.6 | redis2.8

" + }, + "Description":{ + "shape":"String", + "documentation":"

A user-specified description for the cache parameter group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheParameterGroup operation.

" + }, + "CreateCacheSecurityGroupMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "Description" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

A name for the cache security group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters. Must not be the word \"Default\".

Example: mysecuritygroup

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the cache security group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheSecurityGroup operation.

" + }, + "CreateCacheSubnetGroupMessage":{ + "type":"structure", + "required":[ + "CacheSubnetGroupName", + "CacheSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

A name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

A description for the cache subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

A list of VPC subnet IDs for the cache subnet group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheSubnetGroup operation.

" + }, + "CreateReplicationGroupMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupId", + "PrimaryClusterId", + "ReplicationGroupDescription" + ], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

" + }, + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of available.

" + }, + "ReplicationGroupDescription":{ + "shape":"String", + "documentation":"

A user-specified description for the replication group.

" + } + }, + "documentation":"

Represents the input of a CreateReplicationGroup operation.

" + }, + "CreateSnapshotMessage":{ + "type":"structure", + "required":[ + "CacheClusterId", + "SnapshotName" + ], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

A name for the snapshot being created.

" + } + }, + "documentation":"

Represents the input of a CreateSnapshotMessage operation.

" + }, + "DeleteCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

" + }, + "FinalSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The name of a final cache cluster snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheCluster operation.

" + }, + "DeleteCacheParameterGroupMessage":{ + "type":"structure", + "required":["CacheParameterGroupName"], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to delete.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheParameterGroup operation.

" + }, + "DeleteCacheSecurityGroupMessage":{ + "type":"structure", + "required":["CacheSecurityGroupName"], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to delete.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheSecurityGroup operation.

" + }, + "DeleteCacheSubnetGroupMessage":{ + "type":"structure", + "required":["CacheSubnetGroupName"], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to delete.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheSubnetGroup operation.

" + }, + "DeleteReplicationGroupMessage":{ + "type":"structure", + "required":["ReplicationGroupId"], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the replication group to be deleted. This parameter is not case sensitive.

" + }, + "RetainPrimaryCluster":{ + "shape":"BooleanOptional", + "documentation":"

If set to true, all of the read replicas will be deleted, but the primary cache cluster will be retained.

" + }, + "FinalSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The name of a final cache cluster snapshot. ElastiCache creates the snapshot from the primary cluster in the replication group, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is deleted immediately afterward.

" + } + }, + "documentation":"

Represents the input of a DeleteReplicationGroup operation.

" + }, + "DeleteSnapshotMessage":{ + "type":"structure", + "required":["SnapshotName"], + "members":{ + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of the snapshot to be deleted.

" + } + }, + "documentation":"

Represents the input of a DeleteSnapshotMessage operation.

" + }, + "DescribeCacheClustersMessage":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ShowCacheNodeInfo":{ + "shape":"BooleanOptional", + "documentation":"

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheClusters operation.

" + }, + "DescribeCacheEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The cache engine to return. Valid values: memcached | redis

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The cache engine version to return.

Example: 1.4.14

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group family to return details for.

Constraints:

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheEngineVersions operation.

" + }, + "DescribeCacheParameterGroupsMessage":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheParameterGroups operation.

" + }, + "DescribeCacheParametersMessage":{ + "type":"structure", + "required":["CacheParameterGroupName"], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group to return details for.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The parameter types to return.

Valid values: user | system | engine-default

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheParameters operation.

" + }, + "DescribeCacheSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheSecurityGroups operation.

" + }, + "DescribeCacheSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheSubnetGroups operation.

" + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["CacheParameterGroupFamily"], + "members":{ + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6 | redis2.8

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeEngineDefaultParameters operation.

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes' worth of events to retrieve.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeEvents operation.

" + }, + "DescribeReplicationGroupsMessage":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReplicationGroups operation.

" + }, + "DescribeReservedCacheNodesMessage":{ + "type":"structure", + "members":{ + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

" + }, + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReservedCacheNodes operation.

" + }, + "DescribeReservedCacheNodesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" + }, + "DescribeSnapshotsListMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

A list of snapshots. Each item in the list contains detailed information about one snapshot.

" + } + }, + "documentation":"

Represents the output of a DescribeSnapshots operation.

" + }, + "DescribeSnapshotsMessage":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

" + }, + "SnapshotSource":{ + "shape":"String", + "documentation":"

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

" + } + }, + "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" + }, + "Double":{"type":"double"}, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

The status of the Amazon EC2 security group.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the Amazon EC2 security group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the Amazon EC2 security group owner.

" + } + }, + "documentation":"

Provides ownership and status information for an Amazon EC2 security group.

" + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

The DNS hostname of the cache node.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

The port number that the cache engine is listening on.

" + } + }, + "documentation":"

Represents the information required for client programs to connect to a cache node.

" + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

Specifies the name of the cache parameter group family to which the engine default parameters apply.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Contains a list of engine default parameters.

" + }, + "CacheNodeTypeSpecificParameters":{ + "shape":"CacheNodeTypeSpecificParametersList", + "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of a DescribeEngineDefaultParameters operation.

" + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The text of the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

The date and time when the event occurred.

" + } + }, + "documentation":"

Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.

" + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

A list of events. Each element in the list contains detailed information about one event.

" + } + }, + "documentation":"

Represents the output of a DescribeEvents operation.

" + }, + "InsufficientCacheClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidCacheClusterStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + "InvalidCacheParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + "InvalidCacheSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

Two or more parameters that must not be used together were used together.

" + } + }, + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

A parameter value is invalid.

" + } + }, + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + "InvalidReplicationGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested replication group is not in the available state.

" + }, + "InvalidSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

An invalid subnet identifier was specified.

" + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + "ModifyCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster identifier. This value is stored as a lowercase string.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For cache clusters running Redis, the value of NumCacheNodesmust be 1.

Note:
Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

" + }, + "CacheNodeIdsToRemove":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

Specifies the VPC Security Groups associated with the cache cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" + }, + "NotificationTopicStatus":{ + "shape":"String", + "documentation":"

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The upgraded version of the cache engine to be run on the cache nodes.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.

Valid values: true | false

Default: true

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

" + }, + "AZMode":{ + "shape":"String", + "documentation":"

Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

" + }, + "NewAvailabilityZones":{ + "shape":"PreferredAvailabilityZoneList", + "documentation":"

The list of Availability Zones where the new Memcached cache nodes will be created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Example: NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d

" + } + }, + "documentation":"

Represents the input of a ModifyCacheCluster operation.

" + }, + "ModifyCacheParameterGroupMessage":{ + "type":"structure", + "required":[ + "CacheParameterGroupName", + "ParameterNameValues" + ], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to modify.

" + }, + "ParameterNameValues":{ + "shape":"ParameterNameValueList", + "documentation":"

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

" + } + }, + "documentation":"

Represents the input of a ModifyCacheParameterGroup operation.

" + }, + "ModifyCacheSubnetGroupMessage":{ + "type":"structure", + "required":["CacheSubnetGroupName"], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

A description for the cache subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 subnet IDs for the cache subnet group.

" + } + }, + "documentation":"

Represents the input of a ModifyCacheSubnetGroup operation.

" + }, + "ModifyReplicationGroupMessage":{ + "type":"structure", + "required":["ReplicationGroupId"], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier of the replication group to modify.

" + }, + "ReplicationGroupDescription":{ + "shape":"String", + "documentation":"

A description for the replication group. Maximum length is 255 characters.

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication groups containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which replication group system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to apply to all of the cache nodes in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" + }, + "NotificationTopicStatus":{ + "shape":"String", + "documentation":"

The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

If false, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The upgraded version of the cache engine to be run on the nodes in the replication group..

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Determines whether minor engine upgrades will be applied automatically to all of the cache nodes in the replication group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

" + }, + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

If this parameter is specified, ElastiCache will promote each of the nodes in the specified cache cluster to the primary role. The nodes of all other clusters in the replication group will be read replicas.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

" + }, + "SnapshottingClusterId":{ + "shape":"String", + "documentation":"

The cache cluster ID that will be used as the daily snapshot source for the replication group.

" + } + }, + "documentation":"

Represents the input of a ModifyReplicationGroups operation.

" + }, + "NodeGroup":{ + "type":"structure", + "members":{ + "NodeGroupId":{ + "shape":"String", + "documentation":"

The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The current state of this replication group - creating, available, etc.

" + }, + "PrimaryEndpoint":{"shape":"Endpoint"}, + "NodeGroupMembers":{ + "shape":"NodeGroupMemberList", + "documentation":"

A list containing information about individual nodes within the node group.

" + } + }, + "documentation":"

Represents a collection of cache nodes in a replication group.

" + }, + "NodeGroupList":{ + "type":"list", + "member":{ + "shape":"NodeGroup", + "locationName":"NodeGroup" + } + }, + "NodeGroupMember":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The ID of the cache cluster to which the node belongs.

" + }, + "CacheNodeId":{ + "shape":"String", + "documentation":"

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" + }, + "ReadEndpoint":{"shape":"Endpoint"}, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the node is located.

" + }, + "CurrentRole":{ + "shape":"String", + "documentation":"

The role that is currently assigned to the node - primary or replica.

" + } + }, + "documentation":"

Represents a single node within a node group.

" + }, + "NodeGroupMemberList":{ + "type":"list", + "member":{ + "shape":"NodeGroupMember", + "locationName":"NodeGroupMember" + } + }, + "NodeQuotaForClusterExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" + }, + "NodeQuotaForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" + }, + "NodeSnapshot":{ + "type":"structure", + "members":{ + "CacheNodeId":{ + "shape":"String", + "documentation":"

The cache node identifier for the node in the source cache cluster.

" + }, + "CacheSize":{ + "shape":"String", + "documentation":"

The size of the cache on the source cache node.

" + }, + "CacheNodeCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cache node was created in the source cache cluster.

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

" + } + }, + "wrapper":true, + "documentation":"

Represents an individual cache node in a snapshot of a cache cluster.

" + }, + "NodeSnapshotList":{ + "type":"list", + "member":{ + "shape":"NodeSnapshot", + "locationName":"NodeSnapshot" + } + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "TopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that identifies the topic.

" + }, + "TopicStatus":{ + "shape":"String", + "documentation":"

The current state of the topic.

" + } + }, + "documentation":"

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

The value of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source of the parameter.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

The valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest cache engine version to which the parameter can apply.

" + } + }, + "documentation":"

Describes an individual setting that controls some aspect of ElastiCache behavior.

" + }, + "ParameterNameValue":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

The value of the parameter.

" + } + }, + "documentation":"

Describes a name-value pair that is used to update the value of a parameter.

" + }, + "ParameterNameValueList":{ + "type":"list", + "member":{ + "shape":"ParameterNameValue", + "locationName":"ParameterNameValue" + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The new number of cache nodes for the cache cluster.

" + }, + "CacheNodeIdsToRemove":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The new cache engine version that the cache cluster will run.

" + } + }, + "documentation":"

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

" + }, + "PreferredAvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PreferredAvailabilityZone" + } + }, + "PurchaseReservedCacheNodesOfferingMessage":{ + "type":"structure", + "required":["ReservedCacheNodesOfferingId"], + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the reserved cache node offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

A customer-specified identifier to track this reservation.

Example: myreservationID

" + }, + "CacheNodeCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache node instances to reserve.

Default: 1

" + } + }, + "documentation":"

Represents the input of a PurchaseReservedCacheNodesOffering operation.

" + }, + "RebootCacheClusterMessage":{ + "type":"structure", + "required":[ + "CacheClusterId", + "CacheNodeIdsToReboot" + ], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster identifier. This parameter is stored as a lowercase string.

" + }, + "CacheNodeIdsToReboot":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

" + } + }, + "documentation":"

Represents the input of a RebootCacheCluster operation.

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

The monetary amount of the recurring charge.

" + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

The frequency of the recurring charge.

" + } + }, + "wrapper":true, + "documentation":"

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

" + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "ReplicationGroup":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the replication group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the replication group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The current state of this replication group - creating, available, etc.

" + }, + "PendingModifiedValues":{ + "shape":"ReplicationGroupPendingModifiedValues", + "documentation":"

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

" + }, + "MemberClusters":{ + "shape":"ClusterIdList", + "documentation":"

The names of all the cache clusters that are part of this replication group.

" + }, + "NodeGroups":{ + "shape":"NodeGroupList", + "documentation":"

A single element list with information about the nodes in the replication group.

" + }, + "SnapshottingClusterId":{ + "shape":"String", + "documentation":"

The cache cluster ID that is used as the daily snapshot source for the replication group.

" + } + }, + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific replication group.

" + }, + "ReplicationGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReplicationGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group already exists.

" + }, + "ReplicationGroupList":{ + "type":"list", + "member":{ + "shape":"ReplicationGroup", + "locationName":"ReplicationGroup" + } + }, + "ReplicationGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReplicationGroups":{ + "shape":"ReplicationGroupList", + "documentation":"

A list of replication groups. Each item in the list contains detailed information about one replication group.

" + } + }, + "documentation":"

Represents the output of a DescribeReplicationGroups operation.

" + }, + "ReplicationGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + "ReplicationGroupPendingModifiedValues":{ + "type":"structure", + "members":{ + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.

" + } + }, + "documentation":"

The settings to be applied to the replication group, either immediately or during the next maintenance window.

" + }, + "ReservedCacheNode":{ + "type":"structure", + "members":{ + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

The unique identifier for the reservation.

" + }, + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for the reserved cache nodes.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The time the reservation started.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this reserved cache node.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this reserved cache node.

" + }, + "CacheNodeCount":{ + "shape":"Integer", + "documentation":"

The number of cache nodes that have been reserved.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The description of the reserved cache node.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type of this reserved cache node.

" + }, + "State":{ + "shape":"String", + "documentation":"

The state of the reserved cache node.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved cache node.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of a PurchaseReservedCacheNodesOffering operation.

" + }, + "ReservedCacheNodeAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedCacheNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a reservation with the given identifier.

" + }, + "ReservedCacheNodeList":{ + "type":"list", + "member":{ + "shape":"ReservedCacheNode", + "locationName":"ReservedCacheNode" + } + }, + "ReservedCacheNodeMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReservedCacheNodes":{ + "shape":"ReservedCacheNodeList", + "documentation":"

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

" + } + }, + "documentation":"

Represents the output of a DescribeReservedCacheNodes operation.

" + }, + "ReservedCacheNodeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedCacheNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested reserved cache node was not found.

" + }, + "ReservedCacheNodeQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedCacheNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the user's cache node quota.

" + }, + "ReservedCacheNodesOffering":{ + "type":"structure", + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

A unique identifier for the reserved cache node offering.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for the reserved cache node.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering. in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this offering.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this offering.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The cache engine used by the offering.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved cache node.

" + } + }, + "wrapper":true, + "documentation":"

Describes all of the attributes of a reserved cache node offering.

" + }, + "ReservedCacheNodesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedCacheNodesOffering", + "locationName":"ReservedCacheNodesOffering" + } + }, + "ReservedCacheNodesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReservedCacheNodesOfferings":{ + "shape":"ReservedCacheNodesOfferingList", + "documentation":"

A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

" + } + }, + "documentation":"

Represents the output of a DescribeReservedCacheNodesOfferings operation.

" + }, + "ReservedCacheNodesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedCacheNodesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node offering does not exist.

" + }, + "ResetCacheParameterGroupMessage":{ + "type":"structure", + "required":[ + "CacheParameterGroupName", + "ParameterNameValues" + ], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to reset.

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

If true, all parameters in the cache parameter group will be reset to default values. If false, no such action occurs.

Valid values: true | false

" + }, + "ParameterNameValues":{ + "shape":"ParameterNameValueList", + "documentation":"

An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name.

" + } + }, + "documentation":"

Represents the input of a ResetCacheParameterGroup operation.

" + }, + "RevokeCacheSecurityGroupIngressMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to revoke ingress from.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the Amazon EC2 security group to revoke access from.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" + } + }, + "documentation":"

Represents the input of a RevokeCacheSecurityGroupIngress operation.

" + }, + "SecurityGroupIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupMembership":{ + "type":"structure", + "members":{ + "SecurityGroupId":{ + "shape":"String", + "documentation":"

The identifier of the cache security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

" + } + }, + "documentation":"

Represents a single cache security group and its status..

" + }, + "SecurityGroupMembershipList":{ + "type":"list", + "member":{"shape":"SecurityGroupMembership"} + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

" + }, + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied identifier of the source cache cluster.

" + }, + "SnapshotStatus":{ + "shape":"String", + "documentation":"

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

" + }, + "SnapshotSource":{ + "shape":"String", + "documentation":"

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The name of the compute and memory capacity node type for the source cache cluster.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine (memcached or redis) used by the source cache cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the cache engine version that is used by the source cache cluster.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes in the source cache cluster.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the source cache cluster is located.

" + }, + "CacheClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the source cache cluster was created.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.

" + }, + "TopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number used by each cache nodes in the source cache cluster.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The cache parameter group that is associated with the source cache cluster.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group associated with the source cache cluster.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

For the source cache cluster, indicates whether minor version patches are applied automatically (true) or not (false).

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

" + }, + "NodeSnapshots":{ + "shape":"NodeSnapshotList", + "documentation":"

A list of the cache nodes in the source cache cluster.

" + } + }, + "wrapper":true, + "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

" + }, + "SnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + "SnapshotArnsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotArn" + } + }, + "SnapshotFeatureNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You attempted one of the following actions:

Neither of these are supported by ElastiCache.

" + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"Snapshot" + } + }, + "SnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + "SourceType":{ + "type":"string", + "enum":[ + "cache-cluster", + "cache-parameter-group", + "cache-security-group", + "cache-subnet-group" + ] + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

The unique identifier for the subnet

" + }, + "SubnetAvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

The Availability Zone associated with the subnet

" + } + }, + "documentation":"

Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

" + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is being used by another cache subnet group.

" + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "TStamp":{"type":"timestamp"}, + "AuthorizeCacheSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CreateCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "CreateCacheParameterGroupResult":{ + "type":"structure", + "members":{ + "CacheParameterGroup":{"shape":"CacheParameterGroup"} + } + }, + "CreateCacheSecurityGroupResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + }, + "CreateCacheSubnetGroupResult":{ + "type":"structure", + "members":{ + "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} + } + }, + "CreateReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "CreateSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "DeleteCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "DeleteReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "DeleteSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "ModifyCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "ModifyCacheSubnetGroupResult":{ + "type":"structure", + "members":{ + "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} + } + }, + "ModifyReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "PurchaseReservedCacheNodesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedCacheNode":{"shape":"ReservedCacheNode"} + } + }, + "RebootCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "RevokeCacheSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + } + } +} diff --git a/apis/elasticache-2014-07-15.paginators.json b/apis/elasticache-2014-07-15.paginators.json new file mode 100644 index 0000000000..8724740d6f --- /dev/null +++ b/apis/elasticache-2014-07-15.paginators.json @@ -0,0 +1,76 @@ +{ + "pagination": { + "DescribeCacheClusters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheClusters" + }, + "DescribeCacheEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheEngineVersions" + }, + "DescribeCacheParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheParameterGroups" + }, + "DescribeCacheParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeCacheSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheSecurityGroups" + }, + "DescribeCacheSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeReservedCacheNodes": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedCacheNodes" + }, + "DescribeReservedCacheNodesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedCacheNodesOfferings" + }, + "DescribeReplicationGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReplicationGroups" + }, + "DescribeSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Snapshots" + } + } +} diff --git a/apis/elasticbeanstalk-2010-12-01.api.json b/apis/elasticbeanstalk-2010-12-01.api.json new file mode 100644 index 0000000000..c223a7b2a0 --- /dev/null +++ b/apis/elasticbeanstalk-2010-12-01.api.json @@ -0,0 +1,896 @@ +{ + "metadata": { + "apiVersion": "2010-12-01", + "endpointPrefix": "elasticbeanstalk", + "serviceAbbreviation": "Elastic Beanstalk", + "serviceFullName": "AWS Elastic Beanstalk", + "signatureVersion": "v4", + "xmlNamespace": "http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/", + "protocol": "query" + }, + "operations": { + "CheckDNSAvailability": { + "input": { + "type": "structure", + "required": [ + "CNAMEPrefix" + ], + "members": { + "CNAMEPrefix": {} + } + }, + "output": { + "resultWrapper": "CheckDNSAvailabilityResult", + "type": "structure", + "members": { + "Available": { + "type": "boolean" + }, + "FullyQualifiedCNAME": {} + } + } + }, + "CreateApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "Description": {} + } + }, + "output": { + "shape": "S9", + "resultWrapper": "CreateApplicationResult" + } + }, + "CreateApplicationVersion": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "VersionLabel" + ], + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "Description": {}, + "SourceBundle": { + "shape": "Si" + }, + "AutoCreateApplication": { + "type": "boolean" + } + } + }, + "output": { + "shape": "Sm", + "resultWrapper": "CreateApplicationVersionResult" + } + }, + "CreateConfigurationTemplate": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "TemplateName" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "SolutionStackName": {}, + "SourceConfiguration": { + "type": "structure", + "members": { + "ApplicationName": {}, + "TemplateName": {} + } + }, + "EnvironmentId": {}, + "Description": {}, + "OptionSettings": { + "shape": "Ss" + } + } + }, + "output": { + "shape": "Sx", + "resultWrapper": "CreateConfigurationTemplateResult" + } + }, + "CreateEnvironment": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "EnvironmentName" + ], + "members": { + "ApplicationName": {}, + "EnvironmentName": {}, + "Description": {}, + "CNAMEPrefix": {}, + "Tier": { + "shape": "S11" + }, + "Tags": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "VersionLabel": {}, + "TemplateName": {}, + "SolutionStackName": {}, + "OptionSettings": { + "shape": "Ss" + }, + "OptionsToRemove": { + "shape": "S17" + } + } + }, + "output": { + "shape": "S19", + "resultWrapper": "CreateEnvironmentResult" + } + }, + "CreateStorageLocation": { + "output": { + "resultWrapper": "CreateStorageLocationResult", + "type": "structure", + "members": { + "S3Bucket": {} + } + } + }, + "DeleteApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "TerminateEnvByForce": { + "type": "boolean" + } + } + } + }, + "DeleteApplicationVersion": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "VersionLabel" + ], + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "DeleteSourceBundle": { + "type": "boolean" + } + } + } + }, + "DeleteConfigurationTemplate": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "TemplateName" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {} + } + } + }, + "DeleteEnvironmentConfiguration": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "EnvironmentName" + ], + "members": { + "ApplicationName": {}, + "EnvironmentName": {} + } + } + }, + "DescribeApplicationVersions": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "VersionLabels": { + "shape": "Sd" + } + } + }, + "output": { + "resultWrapper": "DescribeApplicationVersionsResult", + "type": "structure", + "members": { + "ApplicationVersions": { + "type": "list", + "member": { + "shape": "Sn" + } + } + } + } + }, + "DescribeApplications": { + "input": { + "type": "structure", + "members": { + "ApplicationNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeApplicationsResult", + "type": "structure", + "members": { + "Applications": { + "type": "list", + "member": { + "shape": "Sa" + } + } + } + } + }, + "DescribeConfigurationOptions": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "EnvironmentName": {}, + "SolutionStackName": {}, + "Options": { + "shape": "S17" + } + } + }, + "output": { + "resultWrapper": "DescribeConfigurationOptionsResult", + "type": "structure", + "members": { + "SolutionStackName": {}, + "Options": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Namespace": {}, + "Name": {}, + "DefaultValue": {}, + "ChangeSeverity": {}, + "UserDefined": { + "type": "boolean" + }, + "ValueType": {}, + "ValueOptions": { + "type": "list", + "member": {} + }, + "MinValue": { + "type": "integer" + }, + "MaxValue": { + "type": "integer" + }, + "MaxLength": { + "type": "integer" + }, + "Regex": { + "type": "structure", + "members": { + "Pattern": {}, + "Label": {} + } + } + } + } + } + } + } + }, + "DescribeConfigurationSettings": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "EnvironmentName": {} + } + }, + "output": { + "resultWrapper": "DescribeConfigurationSettingsResult", + "type": "structure", + "members": { + "ConfigurationSettings": { + "type": "list", + "member": { + "shape": "Sx" + } + } + } + } + }, + "DescribeEnvironmentResources": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {} + } + }, + "output": { + "resultWrapper": "DescribeEnvironmentResourcesResult", + "type": "structure", + "members": { + "EnvironmentResources": { + "type": "structure", + "members": { + "EnvironmentName": {}, + "AutoScalingGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {} + } + } + }, + "LaunchConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "LoadBalancers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "Triggers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {} + } + } + }, + "Queues": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "URL": {} + } + } + } + } + } + } + } + }, + "DescribeEnvironments": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "EnvironmentIds": { + "type": "list", + "member": {} + }, + "EnvironmentNames": { + "type": "list", + "member": {} + }, + "IncludeDeleted": { + "type": "boolean" + }, + "IncludedDeletedBackTo": { + "type": "timestamp" + } + } + }, + "output": { + "resultWrapper": "DescribeEnvironmentsResult", + "type": "structure", + "members": { + "Environments": { + "type": "list", + "member": { + "shape": "S19" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "TemplateName": {}, + "EnvironmentId": {}, + "EnvironmentName": {}, + "RequestId": {}, + "Severity": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EventDate": { + "type": "timestamp" + }, + "Message": {}, + "ApplicationName": {}, + "VersionLabel": {}, + "TemplateName": {}, + "EnvironmentName": {}, + "RequestId": {}, + "Severity": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListAvailableSolutionStacks": { + "output": { + "resultWrapper": "ListAvailableSolutionStacksResult", + "type": "structure", + "members": { + "SolutionStacks": { + "type": "list", + "member": {} + }, + "SolutionStackDetails": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SolutionStackName": {}, + "PermittedFileTypes": { + "type": "list", + "member": {} + } + } + } + } + } + } + }, + "RebuildEnvironment": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {} + } + } + }, + "RequestEnvironmentInfo": { + "input": { + "type": "structure", + "required": [ + "InfoType" + ], + "members": { + "EnvironmentId": {}, + "EnvironmentName": {}, + "InfoType": {} + } + } + }, + "RestartAppServer": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {} + } + } + }, + "RetrieveEnvironmentInfo": { + "input": { + "type": "structure", + "required": [ + "InfoType" + ], + "members": { + "EnvironmentId": {}, + "EnvironmentName": {}, + "InfoType": {} + } + }, + "output": { + "resultWrapper": "RetrieveEnvironmentInfoResult", + "type": "structure", + "members": { + "EnvironmentInfo": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InfoType": {}, + "Ec2InstanceId": {}, + "SampleTimestamp": { + "type": "timestamp" + }, + "Message": {} + } + } + } + } + } + }, + "SwapEnvironmentCNAMEs": { + "input": { + "type": "structure", + "members": { + "SourceEnvironmentId": {}, + "SourceEnvironmentName": {}, + "DestinationEnvironmentId": {}, + "DestinationEnvironmentName": {} + } + } + }, + "TerminateEnvironment": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {}, + "TerminateResources": { + "type": "boolean" + } + } + }, + "output": { + "shape": "S19", + "resultWrapper": "TerminateEnvironmentResult" + } + }, + "UpdateApplication": { + "input": { + "type": "structure", + "required": [ + "ApplicationName" + ], + "members": { + "ApplicationName": {}, + "Description": {} + } + }, + "output": { + "shape": "S9", + "resultWrapper": "UpdateApplicationResult" + } + }, + "UpdateApplicationVersion": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "VersionLabel" + ], + "members": { + "ApplicationName": {}, + "VersionLabel": {}, + "Description": {} + } + }, + "output": { + "shape": "Sm", + "resultWrapper": "UpdateApplicationVersionResult" + } + }, + "UpdateConfigurationTemplate": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "TemplateName" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "Description": {}, + "OptionSettings": { + "shape": "Ss" + }, + "OptionsToRemove": { + "shape": "S17" + } + } + }, + "output": { + "shape": "Sx", + "resultWrapper": "UpdateConfigurationTemplateResult" + } + }, + "UpdateEnvironment": { + "input": { + "type": "structure", + "members": { + "EnvironmentId": {}, + "EnvironmentName": {}, + "Description": {}, + "Tier": { + "shape": "S11" + }, + "VersionLabel": {}, + "TemplateName": {}, + "OptionSettings": { + "shape": "Ss" + }, + "OptionsToRemove": { + "shape": "S17" + } + } + }, + "output": { + "shape": "S19", + "resultWrapper": "UpdateEnvironmentResult" + } + }, + "ValidateConfigurationSettings": { + "input": { + "type": "structure", + "required": [ + "ApplicationName", + "OptionSettings" + ], + "members": { + "ApplicationName": {}, + "TemplateName": {}, + "EnvironmentName": {}, + "OptionSettings": { + "shape": "Ss" + } + } + }, + "output": { + "resultWrapper": "ValidateConfigurationSettingsResult", + "type": "structure", + "members": { + "Messages": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Message": {}, + "Severity": {}, + "Namespace": {}, + "OptionName": {} + } + } + } + } + } + } + }, + "shapes": { + "S9": { + "type": "structure", + "members": { + "Application": { + "shape": "Sa" + } + } + }, + "Sa": { + "type": "structure", + "members": { + "ApplicationName": {}, + "Description": {}, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + }, + "Versions": { + "shape": "Sd" + }, + "ConfigurationTemplates": { + "type": "list", + "member": {} + } + } + }, + "Sd": { + "type": "list", + "member": {} + }, + "Si": { + "type": "structure", + "members": { + "S3Bucket": {}, + "S3Key": {} + } + }, + "Sm": { + "type": "structure", + "members": { + "ApplicationVersion": { + "shape": "Sn" + } + } + }, + "Sn": { + "type": "structure", + "members": { + "ApplicationName": {}, + "Description": {}, + "VersionLabel": {}, + "SourceBundle": { + "shape": "Si" + }, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + } + } + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Namespace": {}, + "OptionName": {}, + "Value": {} + } + } + }, + "Sx": { + "type": "structure", + "members": { + "SolutionStackName": {}, + "ApplicationName": {}, + "TemplateName": {}, + "Description": {}, + "EnvironmentName": {}, + "DeploymentStatus": {}, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + }, + "OptionSettings": { + "shape": "Ss" + } + } + }, + "S11": { + "type": "structure", + "members": { + "Name": {}, + "Type": {}, + "Version": {} + } + }, + "S17": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Namespace": {}, + "OptionName": {} + } + } + }, + "S19": { + "type": "structure", + "members": { + "EnvironmentName": {}, + "EnvironmentId": {}, + "ApplicationName": {}, + "VersionLabel": {}, + "SolutionStackName": {}, + "TemplateName": {}, + "Description": {}, + "EndpointURL": {}, + "CNAME": {}, + "DateCreated": { + "type": "timestamp" + }, + "DateUpdated": { + "type": "timestamp" + }, + "Status": {}, + "Health": {}, + "Resources": { + "type": "structure", + "members": { + "LoadBalancer": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "Domain": {}, + "Listeners": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Protocol": {}, + "Port": { + "type": "integer" + } + } + } + } + } + } + } + }, + "Tier": { + "shape": "S11" + } + } + } + } +} \ No newline at end of file diff --git a/apis/elasticbeanstalk-2010-12-01.full.json b/apis/elasticbeanstalk-2010-12-01.full.json new file mode 100644 index 0000000000..9a7e4c4884 --- /dev/null +++ b/apis/elasticbeanstalk-2010-12-01.full.json @@ -0,0 +1,2445 @@ +{ + "metadata":{ + "apiVersion":"2010-12-01", + "endpointPrefix":"elasticbeanstalk", + "serviceAbbreviation":"Elastic Beanstalk", + "serviceFullName":"AWS Elastic Beanstalk", + "signatureVersion":"v4", + "xmlNamespace":"http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/", + "protocol":"query" + }, + "documentation":"AWS Elastic Beanstalk

This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors.

AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl.

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.

", + "operations":{ + "CheckDNSAvailability":{ + "name":"CheckDNSAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CheckDNSAvailabilityMessage", + "documentation":"

Results message indicating whether a CNAME is available.

" + }, + "output":{ + "shape":"CheckDNSAvailabilityResultMessage", + "documentation":"

Indicates if the specified CNAME is available.

", + "resultWrapper":"CheckDNSAvailabilityResult" + }, + "documentation":"

Checks if the specified CNAME is available.

" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateApplicationMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"ApplicationDescriptionMessage", + "documentation":"

Result message containing a single description of an application.

", + "resultWrapper":"CreateApplicationResult" + }, + "errors":[ + { + "shape":"TooManyApplicationsException", + "error":{ + "code":"TooManyApplicationsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller has exceeded the limit on the number of applications associated with their account.

" + } + ], + "documentation":"

Creates an application that has one configuration template named default and no application versions.

" + }, + "CreateApplicationVersion":{ + "name":"CreateApplicationVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateApplicationVersionMessage", + "documentation":"

" + }, + "output":{ + "shape":"ApplicationVersionDescriptionMessage", + "documentation":"

Result message wrapping a single description of an application version.

", + "resultWrapper":"CreateApplicationVersionResult" + }, + "errors":[ + { + "shape":"TooManyApplicationsException", + "error":{ + "code":"TooManyApplicationsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller has exceeded the limit on the number of applications associated with their account.

" + }, + { + "shape":"TooManyApplicationVersionsException", + "exception":true, + "documentation":"

The caller has exceeded the limit on the number of application versions associated with their account.

" + }, + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + }, + { + "shape":"S3LocationNotInServiceRegionException", + "error":{ + "code":"S3LocationNotInServiceRegionException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified S3 bucket does not belong to the S3 region in which the service is running.

" + } + ], + "documentation":"

Creates an application version for the specified application.

" + }, + "CreateConfigurationTemplate":{ + "name":"CreateConfigurationTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateConfigurationTemplateMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"ConfigurationSettingsDescription", + "documentation":"

Describes the settings for a configuration set.

", + "resultWrapper":"CreateConfigurationTemplateResult" + }, + "errors":[ + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + }, + { + "shape":"TooManyConfigurationTemplatesException", + "error":{ + "code":"TooManyConfigurationTemplatesException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller has exceeded the limit on the number of configuration templates associated with their account.

" + } + ], + "documentation":"

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Related Topics

" + }, + "CreateEnvironment":{ + "name":"CreateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateEnvironmentMessage", + "documentation":"

" + }, + "output":{ + "shape":"EnvironmentDescription", + "documentation":"

Describes the properties of an environment.

", + "resultWrapper":"CreateEnvironmentResult" + }, + "errors":[ + { + "shape":"TooManyEnvironmentsException", + "error":{ + "code":"TooManyEnvironmentsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller has exceeded the limit of allowed environments associated with the account.

" + }, + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + } + ], + "documentation":"

Launches an environment for the specified application using the specified configuration.

" + }, + "CreateStorageLocation":{ + "name":"CreateStorageLocation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"CreateStorageLocationResultMessage", + "documentation":"

Results of a CreateStorageLocationResult call.

", + "resultWrapper":"CreateStorageLocationResult" + }, + "errors":[ + { + "shape":"TooManyBucketsException", + "error":{ + "code":"TooManyBucketsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets.

" + }, + { + "shape":"S3SubscriptionRequiredException", + "error":{ + "code":"S3SubscriptionRequiredException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller does not have a subscription to Amazon S3.

" + }, + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + } + ], + "documentation":"

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

" + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteApplicationMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "errors":[ + { + "shape":"OperationInProgressException", + "error":{ + "code":"OperationInProgressFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.

" + } + ], + "documentation":"

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

" + }, + "DeleteApplicationVersion":{ + "name":"DeleteApplicationVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteApplicationVersionMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "errors":[ + { + "shape":"SourceBundleDeletionException", + "error":{ + "code":"SourceBundleDeletionFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to delete the Amazon S3 source bundle associated with the application version, although the application version deleted successfully.

" + }, + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + }, + { + "shape":"OperationInProgressException", + "error":{ + "code":"OperationInProgressFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.

" + }, + { + "shape":"S3LocationNotInServiceRegionException", + "error":{ + "code":"S3LocationNotInServiceRegionException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified S3 bucket does not belong to the S3 region in which the service is running.

" + } + ], + "documentation":"

Deletes the specified version from the specified application.

" + }, + "DeleteConfigurationTemplate":{ + "name":"DeleteConfigurationTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteConfigurationTemplateMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "errors":[ + { + "shape":"OperationInProgressException", + "error":{ + "code":"OperationInProgressFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.

" + } + ], + "documentation":"

Deletes the specified configuration template.

" + }, + "DeleteEnvironmentConfiguration":{ + "name":"DeleteEnvironmentConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteEnvironmentConfigurationMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "documentation":"

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

" + }, + "DescribeApplicationVersions":{ + "name":"DescribeApplicationVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeApplicationVersionsMessage", + "documentation":"

Result message containing a list of configuration descriptions.

" + }, + "output":{ + "shape":"ApplicationVersionDescriptionsMessage", + "documentation":"

Result message wrapping a list of application version descriptions.

", + "resultWrapper":"DescribeApplicationVersionsResult" + }, + "documentation":"

Returns descriptions for existing application versions.

" + }, + "DescribeApplications":{ + "name":"DescribeApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeApplicationsMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"ApplicationDescriptionsMessage", + "documentation":"

Result message containing a list of application descriptions.

", + "resultWrapper":"DescribeApplicationsResult" + }, + "documentation":"

Returns the descriptions of existing applications.

" + }, + "DescribeConfigurationOptions":{ + "name":"DescribeConfigurationOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeConfigurationOptionsMessage", + "documentation":"

Result message containig a list of application version descriptions.

" + }, + "output":{ + "shape":"ConfigurationOptionsDescription", + "documentation":"

Describes the settings for a specified configuration set.

", + "resultWrapper":"DescribeConfigurationOptionsResult" + }, + "documentation":"

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

" + }, + "DescribeConfigurationSettings":{ + "name":"DescribeConfigurationSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeConfigurationSettingsMessage", + "documentation":"

Result message containing all of the configuration settings for a specified solution stack or configuration template.

" + }, + "output":{ + "shape":"ConfigurationSettingsDescriptions", + "documentation":"

The results from a request to change the configuration settings of an environment.

", + "resultWrapper":"DescribeConfigurationSettingsResult" + }, + "documentation":"

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

" + }, + "DescribeEnvironmentResources":{ + "name":"DescribeEnvironmentResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEnvironmentResourcesMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"EnvironmentResourceDescriptionsMessage", + "documentation":"

Result message containing a list of environment resource descriptions.

", + "resultWrapper":"DescribeEnvironmentResourcesResult" + }, + "errors":[ + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + } + ], + "documentation":"

Returns AWS resources for this environment.

" + }, + "DescribeEnvironments":{ + "name":"DescribeEnvironments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEnvironmentsMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"EnvironmentDescriptionsMessage", + "documentation":"

Result message containing a list of environment descriptions.

", + "resultWrapper":"DescribeEnvironmentsResult" + }, + "documentation":"

Returns descriptions for existing environments.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventsMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"EventDescriptionsMessage", + "documentation":"

Result message wrapping a list of event descriptions.

", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

Returns list of event descriptions matching criteria up to the last 6 weeks.

" + }, + "ListAvailableSolutionStacks":{ + "name":"ListAvailableSolutionStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"ListAvailableSolutionStacksResultMessage", + "documentation":"

A list of available AWS Elastic Beanstalk solution stacks.

", + "resultWrapper":"ListAvailableSolutionStacksResult" + }, + "documentation":"

Returns a list of the available solution stack names.

" + }, + "RebuildEnvironment":{ + "name":"RebuildEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RebuildEnvironmentMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + } + ], + "documentation":"

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

" + }, + "RequestEnvironmentInfo":{ + "name":"RequestEnvironmentInfo", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RequestEnvironmentInfoMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "documentation":"

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

" + }, + "RestartAppServer":{ + "name":"RestartAppServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestartAppServerMessage", + "documentation":"

" + }, + "documentation":"

Causes the environment to restart the application container server running on each Amazon EC2 instance.

" + }, + "RetrieveEnvironmentInfo":{ + "name":"RetrieveEnvironmentInfo", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RetrieveEnvironmentInfoMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"RetrieveEnvironmentInfoResultMessage", + "documentation":"

Result message containing a description of the requested environment info.

", + "resultWrapper":"RetrieveEnvironmentInfoResult" + }, + "documentation":"

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

" + }, + "SwapEnvironmentCNAMEs":{ + "name":"SwapEnvironmentCNAMEs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SwapEnvironmentCNAMEsMessage", + "documentation":"

" + }, + "documentation":"

Swaps the CNAMEs of two environments.

" + }, + "TerminateEnvironment":{ + "name":"TerminateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"TerminateEnvironmentMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"EnvironmentDescription", + "documentation":"

Describes the properties of an environment.

", + "resultWrapper":"TerminateEnvironmentResult" + }, + "errors":[ + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + } + ], + "documentation":"

Terminates the specified environment.

" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateApplicationMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"ApplicationDescriptionMessage", + "documentation":"

Result message containing a single description of an application.

", + "resultWrapper":"UpdateApplicationResult" + }, + "documentation":"

Updates the specified application to have the specified properties.

" + }, + "UpdateApplicationVersion":{ + "name":"UpdateApplicationVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateApplicationVersionMessage", + "documentation":"

" + }, + "output":{ + "shape":"ApplicationVersionDescriptionMessage", + "documentation":"

Result message wrapping a single description of an application version.

", + "resultWrapper":"UpdateApplicationVersionResult" + }, + "documentation":"

Updates the specified application version to have the specified properties.

" + }, + "UpdateConfigurationTemplate":{ + "name":"UpdateConfigurationTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateConfigurationTemplateMessage", + "documentation":"

The result message containing the options for the specified solution stack.

" + }, + "output":{ + "shape":"ConfigurationSettingsDescription", + "documentation":"

Describes the settings for a configuration set.

", + "resultWrapper":"UpdateConfigurationTemplateResult" + }, + "errors":[ + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + } + ], + "documentation":"

Updates the specified configuration template to have the specified properties or configuration option values.

Related Topics

" + }, + "UpdateEnvironment":{ + "name":"UpdateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateEnvironmentMessage", + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "output":{ + "shape":"EnvironmentDescription", + "documentation":"

Describes the properties of an environment.

", + "resultWrapper":"UpdateEnvironmentResult" + }, + "errors":[ + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + } + ], + "documentation":"

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.

" + }, + "ValidateConfigurationSettings":{ + "name":"ValidateConfigurationSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ValidateConfigurationSettingsMessage", + "documentation":"

A list of validation messages for a specified configuration template.

" + }, + "output":{ + "shape":"ConfigurationSettingsValidationMessages", + "documentation":"

Provides a list of validation messages.

", + "resultWrapper":"ValidateConfigurationSettingsResult" + }, + "errors":[ + { + "shape":"InsufficientPrivilegesException", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + } + ], + "documentation":"

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

" + } + }, + "shapes":{ + "ApplicationDescription":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User-defined description of the application.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The date when the application was created.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The date when the application was last modified.

" + }, + "Versions":{ + "shape":"VersionLabelsList", + "documentation":"

The names of the versions for this application.

" + }, + "ConfigurationTemplates":{ + "shape":"ConfigurationTemplateNamesList", + "documentation":"

The names of the configuration templates associated with this application.

" + } + }, + "documentation":"

Describes the properties of an application.

" + }, + "ApplicationDescriptionList":{ + "type":"list", + "member":{"shape":"ApplicationDescription"} + }, + "ApplicationDescriptionMessage":{ + "type":"structure", + "members":{ + "Application":{ + "shape":"ApplicationDescription", + "documentation":"

The ApplicationDescription of the application.

" + } + }, + "documentation":"

Result message containing a single description of an application.

" + }, + "ApplicationDescriptionsMessage":{ + "type":"structure", + "members":{ + "Applications":{ + "shape":"ApplicationDescriptionList", + "documentation":"

This parameter contains a list of ApplicationDescription.

" + } + }, + "documentation":"

Result message containing a list of application descriptions.

" + }, + "ApplicationName":{ + "type":"string", + "min":1, + "max":100 + }, + "ApplicationNamesList":{ + "type":"list", + "member":{"shape":"ApplicationName"} + }, + "ApplicationVersionDescription":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with this release.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description of this application version.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

A label uniquely identifying the version for the associated application.

" + }, + "SourceBundle":{ + "shape":"S3Location", + "documentation":"

The location where the source bundle is located for this version.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The creation date of the application version.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The last modified date of the application version.

" + } + }, + "documentation":"

Describes the properties of an application version.

" + }, + "ApplicationVersionDescriptionList":{ + "type":"list", + "member":{"shape":"ApplicationVersionDescription"} + }, + "ApplicationVersionDescriptionMessage":{ + "type":"structure", + "members":{ + "ApplicationVersion":{ + "shape":"ApplicationVersionDescription", + "documentation":"

The ApplicationVersionDescription of the application version.

" + } + }, + "documentation":"

Result message wrapping a single description of an application version.

" + }, + "ApplicationVersionDescriptionsMessage":{ + "type":"structure", + "members":{ + "ApplicationVersions":{ + "shape":"ApplicationVersionDescriptionList", + "documentation":"

A list of ApplicationVersionDescription .

" + } + }, + "documentation":"

Result message wrapping a list of application version descriptions.

" + }, + "AutoCreateApplication":{"type":"boolean"}, + "AutoScalingGroup":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceId", + "documentation":"

The name of the AutoScalingGroup .

" + } + }, + "documentation":"

Describes an Auto Scaling launch configuration.

" + }, + "AutoScalingGroupList":{ + "type":"list", + "member":{"shape":"AutoScalingGroup"} + }, + "AvailableSolutionStackDetailsList":{ + "type":"list", + "member":{"shape":"SolutionStackDescription"} + }, + "AvailableSolutionStackNamesList":{ + "type":"list", + "member":{"shape":"SolutionStackName"} + }, + "CheckDNSAvailabilityMessage":{ + "type":"structure", + "required":["CNAMEPrefix"], + "members":{ + "CNAMEPrefix":{ + "shape":"DNSCnamePrefix", + "documentation":"

The prefix used when this CNAME is reserved.

" + } + }, + "documentation":"

Results message indicating whether a CNAME is available.

" + }, + "CheckDNSAvailabilityResultMessage":{ + "type":"structure", + "members":{ + "Available":{ + "shape":"CnameAvailability", + "documentation":"

Indicates if the specified CNAME is available:

true : The CNAME is available.

true : The CNAME is not available.

" + }, + "FullyQualifiedCNAME":{ + "shape":"DNSCname", + "documentation":"

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

" + } + }, + "documentation":"

Indicates if the specified CNAME is available.

" + }, + "CnameAvailability":{"type":"boolean"}, + "ConfigurationDeploymentStatus":{ + "type":"string", + "enum":[ + "deployed", + "pending", + "failed" + ] + }, + "ConfigurationOptionDefaultValue":{"type":"string"}, + "ConfigurationOptionDescription":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"OptionNamespace", + "documentation":"

A unique namespace identifying the option's associated AWS resource.

" + }, + "Name":{ + "shape":"ConfigurationOptionName", + "documentation":"

The name of the configuration option.

" + }, + "DefaultValue":{ + "shape":"ConfigurationOptionDefaultValue", + "documentation":"

The default value for this configuration option.

" + }, + "ChangeSeverity":{ + "shape":"ConfigurationOptionSeverity", + "documentation":"

An indication of which action is required if the value for this configuration option changes:

NoInterruption - There is no interruption to the environment or application availability.

RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

" + }, + "UserDefined":{ + "shape":"UserDefinedOption", + "documentation":"

An indication of whether the user defined this configuration option:

true : This configuration option was defined by the user. It is a valid choice for specifying this as an Option to Remove when updating configuration settings.

false : This configuration was not defined by the user.

Constraint: You can remove only UserDefined options from a configuration.

Valid Values: true | false

" + }, + "ValueType":{ + "shape":"ConfigurationOptionValueType", + "documentation":"

An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

Scalar : Values for this option are a single selection from the possible values, or a unformatted string or numeric value governed by the MIN/MAX/Regex constraints:

List : Values for this option are multiple selections of the possible values.

Boolean : Values for this option are either true or false .

" + }, + "ValueOptions":{ + "shape":"ConfigurationOptionPossibleValues", + "documentation":"

If specified, values for the configuration option are selected from this list.

" + }, + "MinValue":{ + "shape":"OptionRestrictionMinValue", + "documentation":"

If specified, the configuration option must be a numeric value greater than this value.

" + }, + "MaxValue":{ + "shape":"OptionRestrictionMaxValue", + "documentation":"

If specified, the configuration option must be a numeric value less than this value.

" + }, + "MaxLength":{ + "shape":"OptionRestrictionMaxLength", + "documentation":"

If specified, the configuration option must be a string value no longer than this value.

" + }, + "Regex":{ + "shape":"OptionRestrictionRegex", + "documentation":"

If specified, the configuration option must be a string value that satisfies this regular expression.

" + } + }, + "documentation":"

Describes the possible values for a configuration option.

" + }, + "ConfigurationOptionDescriptionsList":{ + "type":"list", + "member":{"shape":"ConfigurationOptionDescription"} + }, + "ConfigurationOptionName":{"type":"string"}, + "ConfigurationOptionPossibleValue":{"type":"string"}, + "ConfigurationOptionPossibleValues":{ + "type":"list", + "member":{"shape":"ConfigurationOptionPossibleValue"} + }, + "ConfigurationOptionSetting":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"OptionNamespace", + "documentation":"

A unique namespace identifying the option's associated AWS resource.

" + }, + "OptionName":{ + "shape":"ConfigurationOptionName", + "documentation":"

The name of the configuration option.

" + }, + "Value":{ + "shape":"ConfigurationOptionValue", + "documentation":"

The current value for the configuration option.

" + } + }, + "documentation":"

A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.

" + }, + "ConfigurationOptionSettingsList":{ + "type":"list", + "member":{"shape":"ConfigurationOptionSetting"} + }, + "ConfigurationOptionSeverity":{"type":"string"}, + "ConfigurationOptionValue":{"type":"string"}, + "ConfigurationOptionValueType":{ + "type":"string", + "enum":[ + "Scalar", + "List" + ] + }, + "ConfigurationOptionsDescription":{ + "type":"structure", + "members":{ + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack these configuration options belong to.

" + }, + "Options":{ + "shape":"ConfigurationOptionDescriptionsList", + "documentation":"

A list of ConfigurationOptionDescription.

" + } + }, + "documentation":"

Describes the settings for a specified configuration set.

" + }, + "ConfigurationSettingsDescription":{ + "type":"structure", + "members":{ + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack this configuration set uses.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with this configuration set.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

If not null, the name of the configuration template for this configuration set.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this configuration set.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

If not null, the name of the environment for this configuration set.

" + }, + "DeploymentStatus":{ + "shape":"ConfigurationDeploymentStatus", + "documentation":"

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

null: This configuration is not associated with a running environment.

pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

deployed: This is the configuration that is currently deployed to the associated running environment.

failed: This is a draft configuration, that failed to successfully deploy.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The date (in UTC time) when this configuration set was created.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The date (in UTC time) when this configuration set was last modified.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

A list of the configuration options and their values in this configuration set.

" + } + }, + "documentation":"

Describes the settings for a configuration set.

" + }, + "ConfigurationSettingsDescriptionList":{ + "type":"list", + "member":{"shape":"ConfigurationSettingsDescription"} + }, + "ConfigurationSettingsDescriptions":{ + "type":"structure", + "members":{ + "ConfigurationSettings":{ + "shape":"ConfigurationSettingsDescriptionList", + "documentation":"

A list of ConfigurationSettingsDescription.

" + } + }, + "documentation":"

The results from a request to change the configuration settings of an environment.

" + }, + "ConfigurationSettingsValidationMessages":{ + "type":"structure", + "members":{ + "Messages":{ + "shape":"ValidationMessagesList", + "documentation":"

A list of ValidationMessage.

" + } + }, + "documentation":"

Provides a list of validation messages.

" + }, + "ConfigurationTemplateName":{ + "type":"string", + "min":1, + "max":100 + }, + "ConfigurationTemplateNamesList":{ + "type":"list", + "member":{"shape":"ConfigurationTemplateName"} + }, + "CreateApplicationMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes the application.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "CreateApplicationVersionMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "VersionLabel" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

A label identifying this version.

Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this version.

" + }, + "SourceBundle":{ + "shape":"S3Location", + "documentation":"

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an InvalidParameterValue error. The maximum size allowed is 512 MB.

Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an InvalidParameterCombination error.

" + }, + "AutoCreateApplication":{ + "shape":"AutoCreateApplication", + "documentation":"

Determines how the system behaves if the specified application for this version does not already exist:

true: Automatically creates the specified application for this version if it does not already exist.

false: Returns an InvalidParameterValue if the specified application for this version does not already exist.

Default: false

Valid Values: true | false

" + } + }, + "documentation":"

" + }, + "CreateConfigurationTemplateMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "TemplateName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.

If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.

" + }, + "SourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment used with this configuration template.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this configuration.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "CreateEnvironmentMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "EnvironmentName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 23 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this environment.

" + }, + "CNAMEPrefix":{ + "shape":"DNSCnamePrefix", + "documentation":"

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

" + }, + "Tier":{ + "shape":"EnvironmentTier", + "documentation":"

This specifies the tier to use for creating this environment.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

This specifies the tags applied to resources in the environment.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

" + }, + "OptionsToRemove":{ + "shape":"OptionsSpecifierList", + "documentation":"

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

" + } + }, + "documentation":"

" + }, + "CreateStorageLocationResultMessage":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

The name of the Amazon S3 bucket created.

" + } + }, + "documentation":"

Results of a CreateStorageLocationResult call.

" + }, + "CreationDate":{"type":"timestamp"}, + "DNSCname":{ + "type":"string", + "min":1, + "max":255 + }, + "DNSCnamePrefix":{ + "type":"string", + "min":4, + "max":63 + }, + "DeleteApplicationMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to delete.

" + }, + "TerminateEnvByForce":{ + "shape":"TerminateEnvForce", + "documentation":"

When set to true, running environments will be terminated before deleting the application.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "DeleteApplicationVersionMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "VersionLabel" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to delete releases from.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The label of the version to delete.

" + }, + "DeleteSourceBundle":{ + "shape":"DeleteSourceBundle", + "documentation":"

Indicates whether to delete the associated source bundle from Amazon S3:

Valid Values: true | false

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "DeleteConfigurationTemplateMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "TemplateName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to delete the configuration template from.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to delete.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "DeleteEnvironmentConfigurationMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "EnvironmentName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application the environment is associated with.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to delete the draft configuration from.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "DeleteSourceBundle":{"type":"boolean"}, + "DescribeApplicationVersionsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application.

" + }, + "VersionLabels":{ + "shape":"VersionLabelsList", + "documentation":"

If specified, restricts the returned descriptions to only include ones that have the specified version labels.

" + } + }, + "documentation":"

Result message containing a list of configuration descriptions.

" + }, + "DescribeApplicationsMessage":{ + "type":"structure", + "members":{ + "ApplicationNames":{ + "shape":"ApplicationNamesList", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "DescribeConfigurationOptionsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template whose configuration options you want to describe.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment whose configuration options you want to describe.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack whose configuration options you want to describe.

" + }, + "Options":{ + "shape":"OptionsSpecifierList", + "documentation":"

If specified, restricts the descriptions to only the specified options.

" + } + }, + "documentation":"

Result message containig a list of application version descriptions.

" + }, + "DescribeConfigurationSettingsMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The application for the environment or configuration template.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + } + }, + "documentation":"

Result message containing all of the configuration settings for a specified solution stack or configuration template.

" + }, + "DescribeEnvironmentResourcesMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to retrieve AWS resource usage data.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to retrieve AWS resource usage data.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "DescribeEnvironmentsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

" + }, + "EnvironmentIds":{ + "shape":"EnvironmentIdList", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

" + }, + "EnvironmentNames":{ + "shape":"EnvironmentNamesList", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

" + }, + "IncludeDeleted":{ + "shape":"IncludeDeleted", + "documentation":"

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

" + }, + "IncludedDeletedBackTo":{ + "shape":"IncludeDeletedBackTo", + "documentation":"

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

" + }, + "RequestId":{ + "shape":"RequestId", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

" + }, + "Severity":{ + "shape":"EventSeverity", + "documentation":"

If specified, limits the events returned from this call to include only those with the specified severity or higher.

" + }, + "StartTime":{ + "shape":"TimeFilterStart", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

" + }, + "EndTime":{ + "shape":"TimeFilterEnd", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

Specifies the maximum number of events that can be returned, beginning with the most recent event.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

Pagination token. If specified, the events return the next batch of results.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "Description":{ + "type":"string", + "max":200 + }, + "Ec2InstanceId":{"type":"string"}, + "EndpointURL":{"type":"string"}, + "EnvironmentDescription":{ + "type":"structure", + "members":{ + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of this environment.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of this environment.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with this environment.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The application version deployed in this environment.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the SolutionStack deployed with this environment.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template used to originally launch this environment.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this environment.

" + }, + "EndpointURL":{ + "shape":"EndpointURL", + "documentation":"

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

" + }, + "CNAME":{ + "shape":"DNSCname", + "documentation":"

The URL to the CNAME for this environment.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The creation date for this environment.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The last modified date for this environment.

" + }, + "Status":{ + "shape":"EnvironmentStatus", + "documentation":"

The current operational status of the environment:

" + }, + "Health":{ + "shape":"EnvironmentHealth", + "documentation":"

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

Red : Indicates the environment is not working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

Default: Grey

" + }, + "Resources":{ + "shape":"EnvironmentResourcesDescription", + "documentation":"

The description of the AWS resources used by this environment.

" + }, + "Tier":{ + "shape":"EnvironmentTier", + "documentation":"

Describes the current tier of this environment.

" + } + }, + "documentation":"

Describes the properties of an environment.

" + }, + "EnvironmentDescriptionsList":{ + "type":"list", + "member":{"shape":"EnvironmentDescription"} + }, + "EnvironmentDescriptionsMessage":{ + "type":"structure", + "members":{ + "Environments":{ + "shape":"EnvironmentDescriptionsList", + "documentation":"

Returns an EnvironmentDescription list.

" + } + }, + "documentation":"

Result message containing a list of environment descriptions.

" + }, + "EnvironmentHealth":{ + "type":"string", + "enum":[ + "Green", + "Yellow", + "Red", + "Grey" + ] + }, + "EnvironmentId":{"type":"string"}, + "EnvironmentIdList":{ + "type":"list", + "member":{"shape":"EnvironmentId"} + }, + "EnvironmentInfoDescription":{ + "type":"structure", + "members":{ + "InfoType":{ + "shape":"EnvironmentInfoType", + "documentation":"

The type of information retrieved.

" + }, + "Ec2InstanceId":{ + "shape":"Ec2InstanceId", + "documentation":"

The Amazon EC2 Instance ID for this information.

" + }, + "SampleTimestamp":{ + "shape":"SampleTimestamp", + "documentation":"

The time stamp when this information was retrieved.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

The retrieved information.

" + } + }, + "documentation":"

The information retrieved from the Amazon EC2 instances.

" + }, + "EnvironmentInfoDescriptionList":{ + "type":"list", + "member":{"shape":"EnvironmentInfoDescription"} + }, + "EnvironmentInfoType":{ + "type":"string", + "enum":[ + "tail", + "bundle" + ] + }, + "EnvironmentName":{ + "type":"string", + "min":4, + "max":23 + }, + "EnvironmentNamesList":{ + "type":"list", + "member":{"shape":"EnvironmentName"} + }, + "EnvironmentResourceDescription":{ + "type":"structure", + "members":{ + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment.

" + }, + "AutoScalingGroups":{ + "shape":"AutoScalingGroupList", + "documentation":"

The AutoScalingGroups used by this environment.

" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

The Amazon EC2 instances used by this environment.

" + }, + "LaunchConfigurations":{ + "shape":"LaunchConfigurationList", + "documentation":"

The Auto Scaling launch configurations in use by this environment.

" + }, + "LoadBalancers":{ + "shape":"LoadBalancerList", + "documentation":"

The LoadBalancers in use by this environment.

" + }, + "Triggers":{ + "shape":"TriggerList", + "documentation":"

The AutoScaling triggers in use by this environment.

" + }, + "Queues":{ + "shape":"QueueList", + "documentation":"

The queues used by this environment.

" + } + }, + "documentation":"

Describes the AWS resources in use by this environment. This data is live.

" + }, + "EnvironmentResourceDescriptionsMessage":{ + "type":"structure", + "members":{ + "EnvironmentResources":{ + "shape":"EnvironmentResourceDescription", + "documentation":"

A list of EnvironmentResourceDescription.

" + } + }, + "documentation":"

Result message containing a list of environment resource descriptions.

" + }, + "EnvironmentResourcesDescription":{ + "type":"structure", + "members":{ + "LoadBalancer":{ + "shape":"LoadBalancerDescription", + "documentation":"

Describes the LoadBalancer.

" + } + }, + "documentation":"

Describes the AWS resources in use by this environment. This data is not live data.

" + }, + "EnvironmentStatus":{ + "type":"string", + "enum":[ + "Launching", + "Updating", + "Ready", + "Terminating", + "Terminated" + ] + }, + "EnvironmentTier":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of this environment tier.

" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of this environment tier.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version of this environment tier.

" + } + }, + "documentation":"

Describes the properties of an environment tier

" + }, + "EventDate":{"type":"timestamp"}, + "EventDescription":{ + "type":"structure", + "members":{ + "EventDate":{ + "shape":"EventDate", + "documentation":"

The date when the event occurred.

" + }, + "Message":{ + "shape":"EventMessage", + "documentation":"

The event message.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The application associated with the event.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The release label for the application version associated with this event.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration associated with this event.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment associated with this event.

" + }, + "RequestId":{ + "shape":"RequestId", + "documentation":"

The web service request ID for the activity of this event.

" + }, + "Severity":{ + "shape":"EventSeverity", + "documentation":"

The severity level of this event.

" + } + }, + "documentation":"

Describes an event.

" + }, + "EventDescriptionList":{ + "type":"list", + "member":{"shape":"EventDescription"} + }, + "EventDescriptionsMessage":{ + "type":"structure", + "members":{ + "Events":{ + "shape":"EventDescriptionList", + "documentation":"

A list of EventDescription.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.

" + } + }, + "documentation":"

Result message wrapping a list of event descriptions.

" + }, + "EventMessage":{"type":"string"}, + "EventSeverity":{ + "type":"string", + "enum":[ + "TRACE", + "DEBUG", + "INFO", + "WARN", + "ERROR", + "FATAL" + ] + }, + "FileTypeExtension":{ + "type":"string", + "min":1, + "max":100 + }, + "IncludeDeleted":{"type":"boolean"}, + "IncludeDeletedBackTo":{"type":"timestamp"}, + "Instance":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

The ID of the Amazon EC2 instance.

" + } + }, + "documentation":"

The description of an Amazon EC2 instance.

" + }, + "InstanceList":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InsufficientPrivilegesException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

" + }, + "Integer":{"type":"integer"}, + "LaunchConfiguration":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceId", + "documentation":"

The name of the launch configuration.

" + } + }, + "documentation":"

Describes an Auto Scaling launch configuration.

" + }, + "LaunchConfigurationList":{ + "type":"list", + "member":{"shape":"LaunchConfiguration"} + }, + "ListAvailableSolutionStacksResultMessage":{ + "type":"structure", + "members":{ + "SolutionStacks":{ + "shape":"AvailableSolutionStackNamesList", + "documentation":"

A list of available solution stacks.

" + }, + "SolutionStackDetails":{ + "shape":"AvailableSolutionStackDetailsList", + "documentation":"

A list of available solution stacks and their SolutionStackDescription.

" + } + }, + "documentation":"

A list of available AWS Elastic Beanstalk solution stacks.

" + }, + "Listener":{ + "type":"structure", + "members":{ + "Protocol":{ + "shape":"String", + "documentation":"

The protocol that is used by the Listener.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

The port that is used by the Listener.

" + } + }, + "documentation":"

Describes the properties of a Listener for the LoadBalancer.

" + }, + "LoadBalancer":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceId", + "documentation":"

The name of the LoadBalancer.

" + } + }, + "documentation":"

Describes a LoadBalancer.

" + }, + "LoadBalancerDescription":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"String", + "documentation":"

The name of the LoadBalancer.

" + }, + "Domain":{ + "shape":"String", + "documentation":"

The domain name of the LoadBalancer.

" + }, + "Listeners":{ + "shape":"LoadBalancerListenersDescription", + "documentation":"

A list of Listeners used by the LoadBalancer.

" + } + }, + "documentation":"

Describes the details of a LoadBalancer.

" + }, + "LoadBalancerList":{ + "type":"list", + "member":{"shape":"LoadBalancer"} + }, + "LoadBalancerListenersDescription":{ + "type":"list", + "member":{"shape":"Listener"} + }, + "MaxRecords":{ + "type":"integer", + "min":1, + "max":1000 + }, + "Message":{"type":"string"}, + "OperationInProgressException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OperationInProgressFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.

" + }, + "OptionNamespace":{"type":"string"}, + "OptionRestrictionMaxLength":{"type":"integer"}, + "OptionRestrictionMaxValue":{"type":"integer"}, + "OptionRestrictionMinValue":{"type":"integer"}, + "OptionRestrictionRegex":{ + "type":"structure", + "members":{ + "Pattern":{ + "shape":"RegexPattern", + "documentation":"

The regular expression pattern that a string configuration option value with this restriction must match.

" + }, + "Label":{ + "shape":"RegexLabel", + "documentation":"

A unique name representing this regular expression.

" + } + }, + "documentation":"

A regular expression representing a restriction on a string configuration option value.

" + }, + "OptionSpecification":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"OptionNamespace", + "documentation":"

A unique namespace identifying the option's associated AWS resource.

" + }, + "OptionName":{ + "shape":"ConfigurationOptionName", + "documentation":"

The name of the configuration option.

" + } + }, + "documentation":"

A specification identifying an individual configuration option.

" + }, + "OptionsSpecifierList":{ + "type":"list", + "member":{"shape":"OptionSpecification"} + }, + "Queue":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the queue.

" + }, + "URL":{ + "shape":"String", + "documentation":"

The URL of the queue.

" + } + }, + "documentation":"

Describes a queue.

" + }, + "QueueList":{ + "type":"list", + "member":{"shape":"Queue"} + }, + "RebuildEnvironmentMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to rebuild.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to rebuild.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + } + }, + "documentation":"

" + }, + "RegexLabel":{"type":"string"}, + "RegexPattern":{"type":"string"}, + "RequestEnvironmentInfoMessage":{ + "type":"structure", + "required":["InfoType"], + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "InfoType":{ + "shape":"EnvironmentInfoType", + "documentation":"

The type of information to request.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "RequestId":{"type":"string"}, + "ResourceId":{"type":"string"}, + "RestartAppServerMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to restart the server for.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to restart the server for.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + } + }, + "documentation":"

" + }, + "RetrieveEnvironmentInfoMessage":{ + "type":"structure", + "required":["InfoType"], + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "InfoType":{ + "shape":"EnvironmentInfoType", + "documentation":"

The type of information to retrieve.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "RetrieveEnvironmentInfoResultMessage":{ + "type":"structure", + "members":{ + "EnvironmentInfo":{ + "shape":"EnvironmentInfoDescriptionList", + "documentation":"

The EnvironmentInfoDescription of the environment.

" + } + }, + "documentation":"

Result message containing a description of the requested environment info.

" + }, + "S3Bucket":{ + "type":"string", + "max":255 + }, + "S3Key":{ + "type":"string", + "max":1024 + }, + "S3Location":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

The Amazon S3 bucket where the data is located.

" + }, + "S3Key":{ + "shape":"S3Key", + "documentation":"

The Amazon S3 key where the data is located.

" + } + }, + "documentation":"

A specification of a location in Amazon S3.

" + }, + "S3LocationNotInServiceRegionException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"S3LocationNotInServiceRegionException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified S3 bucket does not belong to the S3 region in which the service is running.

" + }, + "S3SubscriptionRequiredException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"S3SubscriptionRequiredException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller does not have a subscription to Amazon S3.

" + }, + "SampleTimestamp":{"type":"timestamp"}, + "SolutionStackDescription":{ + "type":"structure", + "members":{ + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack.

" + }, + "PermittedFileTypes":{ + "shape":"SolutionStackFileTypeList", + "documentation":"

The permitted file types allowed for a solution stack.

" + } + }, + "documentation":"

Describes the solution stack.

" + }, + "SolutionStackFileTypeList":{ + "type":"list", + "member":{"shape":"FileTypeExtension"} + }, + "SolutionStackName":{ + "type":"string", + "max":100 + }, + "SourceBundleDeletionException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceBundleDeletionFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Unable to delete the Amazon S3 source bundle associated with the application version, although the application version deleted successfully.

" + }, + "SourceConfiguration":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with the configuration.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template.

" + } + }, + "documentation":"

A specification for an environment configuration

" + }, + "String":{"type":"string"}, + "SwapEnvironmentCNAMEsMessage":{ + "type":"structure", + "members":{ + "SourceEnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the source environment.

Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.

" + }, + "SourceEnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the source environment.

Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.

" + }, + "DestinationEnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the destination environment.

Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId.

" + }, + "DestinationEnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the destination environment.

Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.

" + } + }, + "documentation":"

" + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

Describes a tag applied to a resource in an environment.

" + }, + "TagKey":{ + "type":"string", + "min":1, + "max":128 + }, + "TagValue":{ + "type":"string", + "min":1, + "max":256 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TerminateEnvForce":{"type":"boolean"}, + "TerminateEnvironmentMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "TerminateResources":{ + "shape":"TerminateEnvironmentResources", + "documentation":"

Indicates whether the associated AWS resources should shut down when the environment is terminated:

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "TerminateEnvironmentResources":{"type":"boolean"}, + "TimeFilterEnd":{"type":"timestamp"}, + "TimeFilterStart":{"type":"timestamp"}, + "Token":{"type":"string"}, + "TooManyApplicationVersionsException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

The caller has exceeded the limit on the number of application versions associated with their account.

" + }, + "TooManyApplicationsException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TooManyApplicationsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller has exceeded the limit on the number of applications associated with their account.

" + }, + "TooManyBucketsException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TooManyBucketsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets.

" + }, + "TooManyConfigurationTemplatesException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TooManyConfigurationTemplatesException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller has exceeded the limit on the number of configuration templates associated with their account.

" + }, + "TooManyEnvironmentsException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TooManyEnvironmentsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The caller has exceeded the limit of allowed environments associated with the account.

" + }, + "Trigger":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceId", + "documentation":"

The name of the trigger.

" + } + }, + "documentation":"

Describes a trigger.

" + }, + "TriggerList":{ + "type":"list", + "member":{"shape":"Trigger"} + }, + "UpdateApplicationMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A new description for the application.

Default: If not specified, AWS Elastic Beanstalk does not update the description.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "UpdateApplicationVersionMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "VersionLabel" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with this version.

If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A new description for this release.

" + } + }, + "documentation":"

" + }, + "UpdateConfigurationTemplateMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "TemplateName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A new description for the configuration.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

A list of configuration option settings to update with the new specified option value.

" + }, + "OptionsToRemove":{ + "shape":"OptionsSpecifierList", + "documentation":"

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

" + } + }, + "documentation":"

The result message containing the options for the specified solution stack.

" + }, + "UpdateDate":{"type":"timestamp"}, + "UpdateEnvironmentMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

" + }, + "Tier":{ + "shape":"EnvironmentTier", + "documentation":"

This specifies the tier to use to update the environment.

Condition: You can only update the tier version for an environment. If you change the name of the type, AWS Elastic Beanstalk returns InvalidParameterValue error.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

" + }, + "OptionsToRemove":{ + "shape":"OptionsSpecifierList", + "documentation":"

A list of custom user-defined configuration options to remove from the configuration set for this environment.

" + } + }, + "documentation":"

This documentation target is not reported in the API reference.

" + }, + "UserDefinedOption":{"type":"boolean"}, + "ValidateConfigurationSettingsMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "OptionSettings" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application that the configuration template or environment belongs to.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to validate the settings against.

Condition: You cannot specify both this and an environment name.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to validate the settings against.

Condition: You cannot specify both this and a configuration template name.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

A list of the options and desired values to evaluate.

" + } + }, + "documentation":"

A list of validation messages for a specified configuration template.

" + }, + "ValidationMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"ValidationMessageString", + "documentation":"

A message describing the error or warning.

" + }, + "Severity":{ + "shape":"ValidationSeverity", + "documentation":"

An indication of the severity of this message:

error: This message indicates that this is not a valid setting for an option.

warning: This message is providing information you should take into account.

" + }, + "Namespace":{ + "shape":"OptionNamespace", + "documentation":"

" + }, + "OptionName":{ + "shape":"ConfigurationOptionName", + "documentation":"

" + } + }, + "documentation":"

An error or warning for a desired configuration option value.

" + }, + "ValidationMessageString":{"type":"string"}, + "ValidationMessagesList":{ + "type":"list", + "member":{"shape":"ValidationMessage"} + }, + "ValidationSeverity":{ + "type":"string", + "enum":[ + "error", + "warning" + ] + }, + "VersionLabel":{ + "type":"string", + "min":1, + "max":100 + }, + "VersionLabelsList":{ + "type":"list", + "member":{"shape":"VersionLabel"} + } + } +} diff --git a/apis/elasticbeanstalk-2010-12-01.paginators.json b/apis/elasticbeanstalk-2010-12-01.paginators.json new file mode 100644 index 0000000000..383ce8d6f8 --- /dev/null +++ b/apis/elasticbeanstalk-2010-12-01.paginators.json @@ -0,0 +1,25 @@ +{ + "pagination": { + "DescribeApplicationVersions": { + "result_key": "ApplicationVersions" + }, + "DescribeApplications": { + "result_key": "Applications" + }, + "DescribeConfigurationOptions": { + "result_key": "Options" + }, + "DescribeEnvironments": { + "result_key": "Environments" + }, + "DescribeEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "ListAvailableSolutionStacks": { + "result_key": "SolutionStacks" + } + } +} diff --git a/apis/elasticloadbalancing-2012-06-01.api.json b/apis/elasticloadbalancing-2012-06-01.api.json new file mode 100644 index 0000000000..3ebd205407 --- /dev/null +++ b/apis/elasticloadbalancing-2012-06-01.api.json @@ -0,0 +1,962 @@ +{ + "metadata": { + "apiVersion": "2012-06-01", + "endpointPrefix": "elasticloadbalancing", + "serviceFullName": "Elastic Load Balancing", + "signatureVersion": "v4", + "xmlNamespace": "http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/", + "protocol": "query" + }, + "operations": { + "AddTags": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerNames", + "Tags" + ], + "members": { + "LoadBalancerNames": { + "shape": "S2" + }, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "resultWrapper": "AddTagsResult", + "type": "structure", + "members": {} + } + }, + "ApplySecurityGroupsToLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "SecurityGroups" + ], + "members": { + "LoadBalancerName": {}, + "SecurityGroups": { + "shape": "Sa" + } + } + }, + "output": { + "resultWrapper": "ApplySecurityGroupsToLoadBalancerResult", + "type": "structure", + "members": { + "SecurityGroups": { + "shape": "Sa" + } + } + } + }, + "AttachLoadBalancerToSubnets": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Subnets" + ], + "members": { + "LoadBalancerName": {}, + "Subnets": { + "shape": "Se" + } + } + }, + "output": { + "resultWrapper": "AttachLoadBalancerToSubnetsResult", + "type": "structure", + "members": { + "Subnets": { + "shape": "Se" + } + } + } + }, + "ConfigureHealthCheck": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "HealthCheck" + ], + "members": { + "LoadBalancerName": {}, + "HealthCheck": { + "shape": "Si" + } + } + }, + "output": { + "resultWrapper": "ConfigureHealthCheckResult", + "type": "structure", + "members": { + "HealthCheck": { + "shape": "Si" + } + } + } + }, + "CreateAppCookieStickinessPolicy": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "PolicyName", + "CookieName" + ], + "members": { + "LoadBalancerName": {}, + "PolicyName": {}, + "CookieName": {} + } + }, + "output": { + "resultWrapper": "CreateAppCookieStickinessPolicyResult", + "type": "structure", + "members": {} + } + }, + "CreateLBCookieStickinessPolicy": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "PolicyName" + ], + "members": { + "LoadBalancerName": {}, + "PolicyName": {}, + "CookieExpirationPeriod": { + "type": "long" + } + } + }, + "output": { + "resultWrapper": "CreateLBCookieStickinessPolicyResult", + "type": "structure", + "members": {} + } + }, + "CreateLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Listeners" + ], + "members": { + "LoadBalancerName": {}, + "Listeners": { + "shape": "Sx" + }, + "AvailabilityZones": { + "shape": "S13" + }, + "Subnets": { + "shape": "Se" + }, + "SecurityGroups": { + "shape": "Sa" + }, + "Scheme": {}, + "Tags": { + "shape": "S4" + } + } + }, + "output": { + "resultWrapper": "CreateLoadBalancerResult", + "type": "structure", + "members": { + "DNSName": {} + } + } + }, + "CreateLoadBalancerListeners": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Listeners" + ], + "members": { + "LoadBalancerName": {}, + "Listeners": { + "shape": "Sx" + } + } + }, + "output": { + "resultWrapper": "CreateLoadBalancerListenersResult", + "type": "structure", + "members": {} + } + }, + "CreateLoadBalancerPolicy": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "PolicyName", + "PolicyTypeName" + ], + "members": { + "LoadBalancerName": {}, + "PolicyName": {}, + "PolicyTypeName": {}, + "PolicyAttributes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValue": {} + } + } + } + } + }, + "output": { + "resultWrapper": "CreateLoadBalancerPolicyResult", + "type": "structure", + "members": {} + } + }, + "DeleteLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName" + ], + "members": { + "LoadBalancerName": {} + } + }, + "output": { + "resultWrapper": "DeleteLoadBalancerResult", + "type": "structure", + "members": {} + } + }, + "DeleteLoadBalancerListeners": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "LoadBalancerPorts" + ], + "members": { + "LoadBalancerName": {}, + "LoadBalancerPorts": { + "type": "list", + "member": { + "type": "integer" + } + } + } + }, + "output": { + "resultWrapper": "DeleteLoadBalancerListenersResult", + "type": "structure", + "members": {} + } + }, + "DeleteLoadBalancerPolicy": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "PolicyName" + ], + "members": { + "LoadBalancerName": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "DeleteLoadBalancerPolicyResult", + "type": "structure", + "members": {} + } + }, + "DeregisterInstancesFromLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Instances" + ], + "members": { + "LoadBalancerName": {}, + "Instances": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "DeregisterInstancesFromLoadBalancerResult", + "type": "structure", + "members": { + "Instances": { + "shape": "S1p" + } + } + } + }, + "DescribeInstanceHealth": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName" + ], + "members": { + "LoadBalancerName": {}, + "Instances": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "DescribeInstanceHealthResult", + "type": "structure", + "members": { + "InstanceStates": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {}, + "State": {}, + "ReasonCode": {}, + "Description": {} + } + } + } + } + } + }, + "DescribeLoadBalancerAttributes": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName" + ], + "members": { + "LoadBalancerName": {} + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancerAttributesResult", + "type": "structure", + "members": { + "LoadBalancerAttributes": { + "shape": "S22" + } + } + } + }, + "DescribeLoadBalancerPolicies": { + "input": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "PolicyNames": { + "shape": "S2g" + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancerPoliciesResult", + "type": "structure", + "members": { + "PolicyDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "PolicyTypeName": {}, + "PolicyAttributeDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeValue": {} + } + } + } + } + } + } + } + } + }, + "DescribeLoadBalancerPolicyTypes": { + "input": { + "type": "structure", + "members": { + "PolicyTypeNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancerPolicyTypesResult", + "type": "structure", + "members": { + "PolicyTypeDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyTypeName": {}, + "Description": {}, + "PolicyAttributeTypeDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AttributeName": {}, + "AttributeType": {}, + "Description": {}, + "DefaultValue": {}, + "Cardinality": {} + } + } + } + } + } + } + } + } + }, + "DescribeLoadBalancers": { + "input": { + "type": "structure", + "members": { + "LoadBalancerNames": { + "shape": "S2" + }, + "Marker": {}, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DescribeLoadBalancersResult", + "type": "structure", + "members": { + "LoadBalancerDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "DNSName": {}, + "CanonicalHostedZoneName": {}, + "CanonicalHostedZoneNameID": {}, + "ListenerDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Listener": { + "shape": "Sy" + }, + "PolicyNames": { + "shape": "S2g" + } + } + } + }, + "Policies": { + "type": "structure", + "members": { + "AppCookieStickinessPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "CookieName": {} + } + } + }, + "LBCookieStickinessPolicies": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PolicyName": {}, + "CookieExpirationPeriod": { + "type": "long" + } + } + } + }, + "OtherPolicies": { + "shape": "S2g" + } + } + }, + "BackendServerDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstancePort": { + "type": "integer" + }, + "PolicyNames": { + "shape": "S2g" + } + } + } + }, + "AvailabilityZones": { + "shape": "S13" + }, + "Subnets": { + "shape": "Se" + }, + "VPCId": {}, + "Instances": { + "shape": "S1p" + }, + "HealthCheck": { + "shape": "Si" + }, + "SourceSecurityGroup": { + "type": "structure", + "members": { + "OwnerAlias": {}, + "GroupName": {} + } + }, + "SecurityGroups": { + "shape": "Sa" + }, + "CreatedTime": { + "type": "timestamp" + }, + "Scheme": {} + } + } + }, + "NextMarker": {} + } + } + }, + "DescribeTags": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerNames" + ], + "members": { + "LoadBalancerNames": { + "type": "list", + "member": {} + } + } + }, + "output": { + "resultWrapper": "DescribeTagsResult", + "type": "structure", + "members": { + "TagDescriptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LoadBalancerName": {}, + "Tags": { + "shape": "S4" + } + } + } + } + } + } + }, + "DetachLoadBalancerFromSubnets": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Subnets" + ], + "members": { + "LoadBalancerName": {}, + "Subnets": { + "shape": "Se" + } + } + }, + "output": { + "resultWrapper": "DetachLoadBalancerFromSubnetsResult", + "type": "structure", + "members": { + "Subnets": { + "shape": "Se" + } + } + } + }, + "DisableAvailabilityZonesForLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "AvailabilityZones" + ], + "members": { + "LoadBalancerName": {}, + "AvailabilityZones": { + "shape": "S13" + } + } + }, + "output": { + "resultWrapper": "DisableAvailabilityZonesForLoadBalancerResult", + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "S13" + } + } + } + }, + "EnableAvailabilityZonesForLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "AvailabilityZones" + ], + "members": { + "LoadBalancerName": {}, + "AvailabilityZones": { + "shape": "S13" + } + } + }, + "output": { + "resultWrapper": "EnableAvailabilityZonesForLoadBalancerResult", + "type": "structure", + "members": { + "AvailabilityZones": { + "shape": "S13" + } + } + } + }, + "ModifyLoadBalancerAttributes": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "LoadBalancerAttributes" + ], + "members": { + "LoadBalancerName": {}, + "LoadBalancerAttributes": { + "shape": "S22" + } + } + }, + "output": { + "resultWrapper": "ModifyLoadBalancerAttributesResult", + "type": "structure", + "members": { + "LoadBalancerName": {}, + "LoadBalancerAttributes": { + "shape": "S22" + } + } + } + }, + "RegisterInstancesWithLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "Instances" + ], + "members": { + "LoadBalancerName": {}, + "Instances": { + "shape": "S1p" + } + } + }, + "output": { + "resultWrapper": "RegisterInstancesWithLoadBalancerResult", + "type": "structure", + "members": { + "Instances": { + "shape": "S1p" + } + } + } + }, + "RemoveTags": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerNames", + "Tags" + ], + "members": { + "LoadBalancerNames": { + "shape": "S2" + }, + "Tags": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {} + } + } + } + } + }, + "output": { + "resultWrapper": "RemoveTagsResult", + "type": "structure", + "members": {} + } + }, + "SetLoadBalancerListenerSSLCertificate": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "LoadBalancerPort", + "SSLCertificateId" + ], + "members": { + "LoadBalancerName": {}, + "LoadBalancerPort": { + "type": "integer" + }, + "SSLCertificateId": {} + } + }, + "output": { + "resultWrapper": "SetLoadBalancerListenerSSLCertificateResult", + "type": "structure", + "members": {} + } + }, + "SetLoadBalancerPoliciesForBackendServer": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "InstancePort", + "PolicyNames" + ], + "members": { + "LoadBalancerName": {}, + "InstancePort": { + "type": "integer" + }, + "PolicyNames": { + "shape": "S2g" + } + } + }, + "output": { + "resultWrapper": "SetLoadBalancerPoliciesForBackendServerResult", + "type": "structure", + "members": {} + } + }, + "SetLoadBalancerPoliciesOfListener": { + "input": { + "type": "structure", + "required": [ + "LoadBalancerName", + "LoadBalancerPort", + "PolicyNames" + ], + "members": { + "LoadBalancerName": {}, + "LoadBalancerPort": { + "type": "integer" + }, + "PolicyNames": { + "shape": "S2g" + } + } + }, + "output": { + "resultWrapper": "SetLoadBalancerPoliciesOfListenerResult", + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "S4": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sa": { + "type": "list", + "member": {} + }, + "Se": { + "type": "list", + "member": {} + }, + "Si": { + "type": "structure", + "required": [ + "Target", + "Interval", + "Timeout", + "UnhealthyThreshold", + "HealthyThreshold" + ], + "members": { + "Target": {}, + "Interval": { + "type": "integer" + }, + "Timeout": { + "type": "integer" + }, + "UnhealthyThreshold": { + "type": "integer" + }, + "HealthyThreshold": { + "type": "integer" + } + } + }, + "Sx": { + "type": "list", + "member": { + "shape": "Sy" + } + }, + "Sy": { + "type": "structure", + "required": [ + "Protocol", + "LoadBalancerPort", + "InstancePort" + ], + "members": { + "Protocol": {}, + "LoadBalancerPort": { + "type": "integer" + }, + "InstanceProtocol": {}, + "InstancePort": { + "type": "integer" + }, + "SSLCertificateId": {} + } + }, + "S13": { + "type": "list", + "member": {} + }, + "S1p": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {} + } + } + }, + "S22": { + "type": "structure", + "members": { + "CrossZoneLoadBalancing": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + } + } + }, + "AccessLog": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "S3BucketName": {}, + "EmitInterval": { + "type": "integer" + }, + "S3BucketPrefix": {} + } + }, + "ConnectionDraining": { + "type": "structure", + "required": [ + "Enabled" + ], + "members": { + "Enabled": { + "type": "boolean" + }, + "Timeout": { + "type": "integer" + } + } + }, + "ConnectionSettings": { + "type": "structure", + "required": [ + "IdleTimeout" + ], + "members": { + "IdleTimeout": { + "type": "integer" + } + } + } + } + }, + "S2g": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/apis/elasticloadbalancing-2012-06-01.full.json b/apis/elasticloadbalancing-2012-06-01.full.json new file mode 100644 index 0000000000..8c3f4de1a4 --- /dev/null +++ b/apis/elasticloadbalancing-2012-06-01.full.json @@ -0,0 +1,2904 @@ +{ + "metadata":{ + "apiVersion":"2012-06-01", + "endpointPrefix":"elasticloadbalancing", + "serviceFullName":"Elastic Load Balancing", + "signatureVersion":"v4", + "xmlNamespace":"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/", + "protocol":"query" + }, + "documentation":"Elastic Load Balancing

Elastic Load Balancing is a way to automatically distribute incoming web traffic across applications that run on multiple Amazon Elastic Compute Cloud (Amazon EC2) instances.

You can create, access, and manage Elastic Load Balancing using the AWS Management Console or the Elastic Load Balancing API. For more information about Elastic Load Balancing interfaces, see Accessing Elastic Load Balancing.

This reference guide contains documentation for the Query API and the AWS command line interface commands, to manage Elastic Load Balancing.

For detailed information about Elastic Load Balancing features and their associated actions or commands, go to Managing Load Balancers in the Elastic Load Balancing Developer Guide.

This reference guide is based on the current WSDL, which is available at: .

Endpoints

The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.

You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see Regions and Endpoints in the Amazon Web Services General Reference.

", + "operations":{ + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddTagsInput", + "documentation":"The input for the AddTags action" + }, + "output":{ + "shape":"AddTagsOutput", + "documentation":"The output for the AddTags action.", + "resultWrapper":"AddTagsResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"TooManyTagsException", + "error":{ + "code":"TooManyTags", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for the number of tags that can be assigned to a load balancer has been reached.

" + }, + { + "shape":"DuplicateTagKeysException", + "error":{ + "code":"DuplicateTagKeys", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The same tag key specified multiple times.

" + } + ], + "documentation":"

Adds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value.

Tag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, this action will update the value of the key.

For more information, see Tagging in the Elastic Load Balancing Developer Guide.

" + }, + "ApplySecurityGroupsToLoadBalancer":{ + "name":"ApplySecurityGroupsToLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ApplySecurityGroupsToLoadBalancerInput", + "documentation":"

The input for the ApplySecurityGroupsToLoadBalancer action.

" + }, + "output":{ + "shape":"ApplySecurityGroupsToLoadBalancerOutput", + "documentation":"

The out for the ApplySecurityGroupsToLoadBalancer action.

", + "resultWrapper":"ApplySecurityGroupsToLoadBalancerResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + }, + { + "shape":"InvalidSecurityGroupException", + "error":{ + "code":"InvalidSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more specified security groups do not exist.

" + } + ], + "documentation":"

Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups.

For more information, see Manage Security Groups in Amazon VPC in the Elastic Load Balancing Developer Guide.

" + }, + "AttachLoadBalancerToSubnets":{ + "name":"AttachLoadBalancerToSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AttachLoadBalancerToSubnetsInput", + "documentation":"

The input for the AttachLoadBalancerToSubnets action.

" + }, + "output":{ + "shape":"AttachLoadBalancerToSubnetsOutput", + "documentation":"

The output for the AttachLoadBalancerToSubnets action.

", + "resultWrapper":"AttachLoadBalancerToSubnetsResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + }, + { + "shape":"SubnetNotFoundException", + "error":{ + "code":"SubnetNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more subnets were not found.

" + }, + { + "shape":"InvalidSubnetException", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC has no Internet gateway.

" + } + ], + "documentation":"

Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.

The load balancers evenly distribute requests across all of the registered subnets. For more information, see Deploy Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide.

" + }, + "ConfigureHealthCheck":{ + "name":"ConfigureHealthCheck", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ConfigureHealthCheckInput", + "documentation":"

Input for the ConfigureHealthCheck action.

" + }, + "output":{ + "shape":"ConfigureHealthCheckOutput", + "documentation":"

The output for the ConfigureHealthCheck action.

", + "resultWrapper":"ConfigureHealthCheckResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + } + ], + "documentation":"

Specifies the health check settings to use for evaluating the health state of your back-end instances.

For more information, see Health Check in the Elastic Load Balancing Developer Guide.

" + }, + "CreateAppCookieStickinessPolicy":{ + "name":"CreateAppCookieStickinessPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateAppCookieStickinessPolicyInput", + "documentation":"

The input for the CreateAppCookieStickinessPolicy action.

" + }, + "output":{ + "shape":"CreateAppCookieStickinessPolicyOutput", + "documentation":"

The output for the CreateAppCookieStickinessPolicy action.

", + "resultWrapper":"CreateAppCookieStickinessPolicyResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"DuplicatePolicyNameException", + "error":{ + "code":"DuplicatePolicyName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Policy with the same name exists for this load balancer. Please choose another name.

" + }, + { + "shape":"TooManyPoliciesException", + "error":{ + "code":"TooManyPolicies", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Quota for number of policies for this load balancer has already been reached.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

For more information, see Enabling Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide.

" + }, + "CreateLBCookieStickinessPolicy":{ + "name":"CreateLBCookieStickinessPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateLBCookieStickinessPolicyInput", + "documentation":"

The input for the CreateLBCookieStickinessPolicy action.

" + }, + "output":{ + "shape":"CreateLBCookieStickinessPolicyOutput", + "documentation":"

The output for the CreateLBCookieStickinessPolicy action.

", + "resultWrapper":"CreateLBCookieStickinessPolicyResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"DuplicatePolicyNameException", + "error":{ + "code":"DuplicatePolicyName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Policy with the same name exists for this load balancer. Please choose another name.

" + }, + { + "shape":"TooManyPoliciesException", + "error":{ + "code":"TooManyPolicies", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Quota for number of policies for this load balancer has already been reached.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

When a load balancer implements this policy, the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

For more information, see Enabling Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide.

" + }, + "CreateLoadBalancer":{ + "name":"CreateLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateAccessPointInput", + "documentation":"

The input for the CreateLoadBalancer action.

" + }, + "output":{ + "shape":"CreateAccessPointOutput", + "documentation":"

The output for the CreateLoadBalancer action.

", + "resultWrapper":"CreateLoadBalancerResult" + }, + "errors":[ + { + "shape":"DuplicateAccessPointNameException", + "error":{ + "code":"DuplicateLoadBalancerName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The load balancer name already exists for this account. Please choose another name.

" + }, + { + "shape":"TooManyAccessPointsException", + "error":{ + "code":"TooManyLoadBalancers", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for the number of load balancers has already been reached.

" + }, + { + "shape":"CertificateNotFoundException", + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + }, + { + "shape":"SubnetNotFoundException", + "error":{ + "code":"SubnetNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more subnets were not found.

" + }, + { + "shape":"InvalidSubnetException", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC has no Internet gateway.

" + }, + { + "shape":"InvalidSecurityGroupException", + "error":{ + "code":"InvalidSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more specified security groups do not exist.

" + }, + { + "shape":"InvalidSchemeException", + "error":{ + "code":"InvalidScheme", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Invalid value for scheme. Scheme can only be specified for load balancers in VPC.

" + }, + { + "shape":"TooManyTagsException", + "error":{ + "code":"TooManyTags", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for the number of tags that can be assigned to a load balancer has been reached.

" + }, + { + "shape":"DuplicateTagKeysException", + "error":{ + "code":"DuplicateTagKeys", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The same tag key specified multiple times.

" + } + ], + "documentation":"

Creates a new load balancer.

After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:

For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints.

You can create up to 20 load balancers per region per account.

Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms:

" + }, + "CreateLoadBalancerListeners":{ + "name":"CreateLoadBalancerListeners", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateLoadBalancerListenerInput", + "documentation":"

The input for the CreateLoadBalancerListeners action.

" + }, + "output":{ + "shape":"CreateLoadBalancerListenerOutput", + "documentation":"

The output for the CreateLoadBalancerListeners action.

", + "resultWrapper":"CreateLoadBalancerListenersResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"DuplicateListenerException", + "error":{ + "code":"DuplicateListener", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A Listener already exists for the given LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId.

" + }, + { + "shape":"CertificateNotFoundException", + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Creates one or more listeners on a load balancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener.

For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide.

" + }, + "CreateLoadBalancerPolicy":{ + "name":"CreateLoadBalancerPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoadBalancerPolicyInput"}, + "output":{ + "shape":"CreateLoadBalancerPolicyOutput", + "documentation":"

The output for the CreateLoadBalancerPolicy action.

", + "resultWrapper":"CreateLoadBalancerPolicyResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"PolicyTypeNotFoundException", + "error":{ + "code":"PolicyTypeNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more of the specified policy types do not exist.

" + }, + { + "shape":"DuplicatePolicyNameException", + "error":{ + "code":"DuplicatePolicyName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Policy with the same name exists for this load balancer. Please choose another name.

" + }, + { + "shape":"TooManyPoliciesException", + "error":{ + "code":"TooManyPolicies", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Quota for number of policies for this load balancer has already been reached.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Creates a new policy that contains the necessary attributes depending on the policy type. Policies are settings that are saved for your load balancer and that can be applied to the front-end listener, or the back-end application server, depending on your policy type.

" + }, + "DeleteLoadBalancer":{ + "name":"DeleteLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteAccessPointInput", + "documentation":"

The input for the DeleteLoadBalancer action.

" + }, + "output":{ + "shape":"DeleteAccessPointOutput", + "documentation":"

The output for the DeleteLoadBalancer action.

", + "resultWrapper":"DeleteLoadBalancerResult" + }, + "documentation":"

Deletes the specified load balancer.

If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances.

To successfully call this API, you must provide the same account credentials as were used to create the load balancer.

" + }, + "DeleteLoadBalancerListeners":{ + "name":"DeleteLoadBalancerListeners", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteLoadBalancerListenerInput", + "documentation":"

The input for the DeleteLoadBalancerListeners action.

" + }, + "output":{ + "shape":"DeleteLoadBalancerListenerOutput", + "documentation":"

The output for the DeleteLoadBalancerListeners action.

", + "resultWrapper":"DeleteLoadBalancerListenersResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + } + ], + "documentation":"

Deletes listeners from the load balancer for the specified port.

" + }, + "DeleteLoadBalancerPolicy":{ + "name":"DeleteLoadBalancerPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteLoadBalancerPolicyInput", + "documentation":"

The input for the DeleteLoadBalancerPolicy action.

" + }, + "output":{ + "shape":"DeleteLoadBalancerPolicyOutput", + "documentation":"

The output for the DeleteLoadBalancerPolicy action.

", + "resultWrapper":"DeleteLoadBalancerPolicyResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners.

" + }, + "DeregisterInstancesFromLoadBalancer":{ + "name":"DeregisterInstancesFromLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeregisterEndPointsInput", + "documentation":"

The input for the DeregisterInstancesFromLoadBalancer action.

" + }, + "output":{ + "shape":"DeregisterEndPointsOutput", + "documentation":"

The output for the DeregisterInstancesFromLoadBalancer action.

", + "resultWrapper":"DeregisterInstancesFromLoadBalancerResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"InvalidEndPointException", + "error":{ + "code":"InvalidInstance", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified EndPoint is not valid.

" + } + ], + "documentation":"

Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer.

In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided.

For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide.

You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.

" + }, + "DescribeInstanceHealth":{ + "name":"DescribeInstanceHealth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEndPointStateInput", + "documentation":"

The input for the DescribeEndPointState action.

" + }, + "output":{ + "shape":"DescribeEndPointStateOutput", + "documentation":"

The output for the DescribeInstanceHealth action.

", + "resultWrapper":"DescribeInstanceHealthResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"InvalidEndPointException", + "error":{ + "code":"InvalidInstance", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified EndPoint is not valid.

" + } + ], + "documentation":"

Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned.

" + }, + "DescribeLoadBalancerAttributes":{ + "name":"DescribeLoadBalancerAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeLoadBalancerAttributesInput", + "documentation":"

The input for the DescribeLoadBalancerAttributes action.

" + }, + "output":{ + "shape":"DescribeLoadBalancerAttributesOutput", + "documentation":"

The following element is returned in a structure named DescribeLoadBalancerAttributesResult.

", + "resultWrapper":"DescribeLoadBalancerAttributesResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"LoadBalancerAttributeNotFoundException", + "error":{ + "code":"LoadBalancerAttributeNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer attribute could not be found.

" + } + ], + "documentation":"

Returns detailed information about all of the attributes associated with the specified load balancer.

" + }, + "DescribeLoadBalancerPolicies":{ + "name":"DescribeLoadBalancerPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancerPoliciesInput"}, + "output":{ + "shape":"DescribeLoadBalancerPoliciesOutput", + "documentation":"

The output for the DescribeLoadBalancerPolicies action.

", + "resultWrapper":"DescribeLoadBalancerPoliciesResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"PolicyNotFoundException", + "error":{ + "code":"PolicyNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more specified policies were not found.

" + } + ], + "documentation":"

Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.

" + }, + "DescribeLoadBalancerPolicyTypes":{ + "name":"DescribeLoadBalancerPolicyTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancerPolicyTypesInput"}, + "output":{ + "shape":"DescribeLoadBalancerPolicyTypesOutput", + "documentation":"

The output for the DescribeLoadBalancerPolicyTypes action.

", + "resultWrapper":"DescribeLoadBalancerPolicyTypesResult" + }, + "errors":[ + { + "shape":"PolicyTypeNotFoundException", + "error":{ + "code":"PolicyTypeNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more of the specified policy types do not exist.

" + } + ], + "documentation":"

Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer.

" + }, + "DescribeLoadBalancers":{ + "name":"DescribeLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeAccessPointsInput", + "documentation":"

The input for the DescribeLoadBalancers action.

" + }, + "output":{ + "shape":"DescribeAccessPointsOutput", + "documentation":"

The output for the DescribeLoadBalancers action.

", + "resultWrapper":"DescribeLoadBalancersResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + } + ], + "documentation":"

Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeTagsInput", + "documentation":"

The input for the DescribeTags action.

" + }, + "output":{ + "shape":"DescribeTagsOutput", + "documentation":"

The output for the DescribeTags action.

", + "resultWrapper":"DescribeTagsResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + } + ], + "documentation":"

Describes the tags associated with one or more load balancers.

" + }, + "DetachLoadBalancerFromSubnets":{ + "name":"DetachLoadBalancerFromSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DetachLoadBalancerFromSubnetsInput", + "documentation":"

The input for the DetachLoadBalancerFromSubnets action.

" + }, + "output":{ + "shape":"DetachLoadBalancerFromSubnetsOutput", + "documentation":"

The output for the DetachLoadBalancerFromSubnets action.

", + "resultWrapper":"DetachLoadBalancerFromSubnetsResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.

After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer.

" + }, + "DisableAvailabilityZonesForLoadBalancer":{ + "name":"DisableAvailabilityZonesForLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveAvailabilityZonesInput", + "documentation":"

The input for the DisableAvailabilityZonesForLoadBalancer action.

" + }, + "output":{ + "shape":"RemoveAvailabilityZonesOutput", + "documentation":"

The output for the DisableAvailabilityZonesForLoadBalancer action.

", + "resultWrapper":"DisableAvailabilityZonesForLoadBalancerResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer.

There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing.

For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide.

" + }, + "EnableAvailabilityZonesForLoadBalancer":{ + "name":"EnableAvailabilityZonesForLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddAvailabilityZonesInput", + "documentation":"

The input for the EnableAvailabilityZonesForLoadBalancer action.

" + }, + "output":{ + "shape":"AddAvailabilityZonesOutput", + "documentation":"

The output for the EnableAvailabilityZonesForLoadBalancer action.

", + "resultWrapper":"EnableAvailabilityZonesForLoadBalancerResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + } + ], + "documentation":"

Adds one or more EC2 Availability Zones to the load balancer.

The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.

For more information, see Expand a Load Balanced Application to an Additional Availability Zone in the Elastic Load Balancing Developer Guide.

" + }, + "ModifyLoadBalancerAttributes":{ + "name":"ModifyLoadBalancerAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyLoadBalancerAttributesInput", + "documentation":"

The input for the ModifyLoadBalancerAttributes action.

" + }, + "output":{ + "shape":"ModifyLoadBalancerAttributesOutput", + "documentation":"

The output for the ModifyLoadBalancerAttributes action.

", + "resultWrapper":"ModifyLoadBalancerAttributesResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"LoadBalancerAttributeNotFoundException", + "error":{ + "code":"LoadBalancerAttributeNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer attribute could not be found.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Modifies the attributes of a specified load balancer.

You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.

For more information, see the following:

" + }, + "RegisterInstancesWithLoadBalancer":{ + "name":"RegisterInstancesWithLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RegisterEndPointsInput", + "documentation":"

The input for the RegisterInstancesWithLoadBalancer action.

" + }, + "output":{ + "shape":"RegisterEndPointsOutput", + "documentation":"

The output for the RegisterInstancesWithLoadBalancer action.

", + "resultWrapper":"RegisterInstancesWithLoadBalancerResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"InvalidEndPointException", + "error":{ + "code":"InvalidInstance", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified EndPoint is not valid.

" + } + ], + "documentation":"

Adds new instances to the load balancer.

Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the load balancer.

When an instance registered with a load balancer is stopped and then restarted, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.

For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide.

You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.

" + }, + "RemoveTags":{ + "name":"RemoveTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTagsInput", + "documentation":"

The input for the RemoveTags action.

" + }, + "output":{ + "shape":"RemoveTagsOutput", + "documentation":"

The output for the RemoveTags action.

", + "resultWrapper":"RemoveTagsResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + } + ], + "documentation":"

Removes one or more tags from the specified load balancer.

" + }, + "SetLoadBalancerListenerSSLCertificate":{ + "name":"SetLoadBalancerListenerSSLCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetLoadBalancerListenerSSLCertificateInput", + "documentation":"

The input for the SetLoadBalancerListenerSSLCertificate action.

" + }, + "output":{ + "shape":"SetLoadBalancerListenerSSLCertificateOutput", + "documentation":"

The output for the SetLoadBalancerListenerSSLCertificate action.

", + "resultWrapper":"SetLoadBalancerListenerSSLCertificateResult" + }, + "errors":[ + { + "shape":"CertificateNotFoundException", + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.

" + }, + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"ListenerNotFoundException", + "error":{ + "code":"ListenerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Load balancer does not have a listener configured at the given port.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.

For more information on updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide.

" + }, + "SetLoadBalancerPoliciesForBackendServer":{ + "name":"SetLoadBalancerPoliciesForBackendServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetLoadBalancerPoliciesForBackendServerInput", + "documentation":"

The input for the SetLoadBalancerPoliciesForBackendServer action.

" + }, + "output":{ + "shape":"SetLoadBalancerPoliciesForBackendServerOutput", + "documentation":"

The output for the SetLoadBalancerPoliciesForBackendServer action.

", + "resultWrapper":"SetLoadBalancerPoliciesForBackendServerResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"PolicyNotFoundException", + "error":{ + "code":"PolicyNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more specified policies were not found.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.

" + }, + "SetLoadBalancerPoliciesOfListener":{ + "name":"SetLoadBalancerPoliciesOfListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetLoadBalancerPoliciesOfListenerInput", + "documentation":"

The input for the SetLoadBalancerPoliciesOfListener action.

" + }, + "output":{ + "shape":"SetLoadBalancerPoliciesOfListenerOutput", + "documentation":"

The output for the SetLoadBalancerPoliciesOfListener action.

", + "resultWrapper":"SetLoadBalancerPoliciesOfListenerResult" + }, + "errors":[ + { + "shape":"AccessPointNotFoundException", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + { + "shape":"PolicyNotFoundException", + "error":{ + "code":"PolicyNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more specified policies were not found.

" + }, + { + "shape":"ListenerNotFoundException", + "error":{ + "code":"ListenerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Load balancer does not have a listener configured at the given port.

" + }, + { + "shape":"InvalidConfigurationRequestException", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + } + ], + "documentation":"

Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener.

" + } + }, + "shapes":{ + "AccessLog":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"AccessLogEnabled", + "documentation":"

Specifies whether access log is enabled for the load balancer.

" + }, + "S3BucketName":{ + "shape":"S3BucketName", + "documentation":"

The name of the Amazon S3 bucket where the access logs are stored.

" + }, + "EmitInterval":{ + "shape":"AccessLogInterval", + "documentation":"

The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

Default: 60 minutes

" + }, + "S3BucketPrefix":{ + "shape":"AccessLogPrefix", + "documentation":"

The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.

" + } + }, + "documentation":"

The AccessLog data type.

" + }, + "AccessLogEnabled":{"type":"boolean"}, + "AccessLogInterval":{"type":"integer"}, + "AccessLogPrefix":{"type":"string"}, + "AccessPointName":{"type":"string"}, + "AccessPointNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer could not be found.

" + }, + "AccessPointPort":{"type":"integer"}, + "AddAvailabilityZonesInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "AvailabilityZones" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

A list of new Availability Zones for the load balancer. Each Availability Zone must be in the same region as the load balancer.

" + } + }, + "documentation":"

The input for the EnableAvailabilityZonesForLoadBalancer action.

" + }, + "AddAvailabilityZonesOutput":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

An updated list of Availability Zones for the load balancer.

" + } + }, + "documentation":"

The output for the EnableAvailabilityZonesForLoadBalancer action.

" + }, + "AddTagsInput":{ + "type":"structure", + "required":[ + "LoadBalancerNames", + "Tags" + ], + "members":{ + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

The name of the load balancer to tag. You can specify a maximum of one load balancer name.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags for each load balancer.

" + } + }, + "documentation":"The input for the AddTags action" + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"The output for the AddTags action." + }, + "AppCookieStickinessPolicies":{ + "type":"list", + "member":{"shape":"AppCookieStickinessPolicy"} + }, + "AppCookieStickinessPolicy":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.

" + }, + "CookieName":{ + "shape":"CookieName", + "documentation":"

The name of the application cookie used for stickiness.

" + } + }, + "documentation":"

The AppCookieStickinessPolicy data type.

" + }, + "ApplySecurityGroupsToLoadBalancerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "SecurityGroups" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

A list of security group IDs to associate with your load balancer in VPC. The security group IDs must be provided as the ID and not the security group name (For example, sg-1234).

" + } + }, + "documentation":"

The input for the ApplySecurityGroupsToLoadBalancer action.

" + }, + "ApplySecurityGroupsToLoadBalancerOutput":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

A list of security group IDs associated with your load balancer.

" + } + }, + "documentation":"

The out for the ApplySecurityGroupsToLoadBalancer action.

" + }, + "AttachLoadBalancerToSubnetsInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Subnets" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

A list of subnet IDs to add for the load balancer. You can add only one subnet per Availability Zone.

" + } + }, + "documentation":"

The input for the AttachLoadBalancerToSubnets action.

" + }, + "AttachLoadBalancerToSubnetsOutput":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"Subnets", + "documentation":"

A list of subnet IDs attached to the load balancer.

" + } + }, + "documentation":"

The output for the AttachLoadBalancerToSubnets action.

" + }, + "AttributeName":{"type":"string"}, + "AttributeType":{"type":"string"}, + "AttributeValue":{"type":"string"}, + "AvailabilityZone":{"type":"string"}, + "AvailabilityZones":{ + "type":"list", + "member":{"shape":"AvailabilityZone"} + }, + "BackendServerDescription":{ + "type":"structure", + "members":{ + "InstancePort":{ + "shape":"InstancePort", + "documentation":"

Provides the port on which the back-end server is listening.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

Provides a list of policy names enabled for the back-end server.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeLoadBalancers action to describe the configuration of the back-end server.

" + }, + "BackendServerDescriptions":{ + "type":"list", + "member":{"shape":"BackendServerDescription"} + }, + "Cardinality":{"type":"string"}, + "CertificateNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.

" + }, + "ConfigureHealthCheckInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "HealthCheck" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The mnemonic name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.

" + }, + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

A structure containing the configuration information for the new healthcheck.

" + } + }, + "documentation":"

Input for the ConfigureHealthCheck action.

" + }, + "ConfigureHealthCheckOutput":{ + "type":"structure", + "members":{ + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

The updated healthcheck for the instances.

" + } + }, + "documentation":"

The output for the ConfigureHealthCheck action.

" + }, + "ConnectionDraining":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"ConnectionDrainingEnabled", + "documentation":"

Specifies whether connection draining is enabled for the load balancer.

" + }, + "Timeout":{ + "shape":"ConnectionDrainingTimeout", + "documentation":"

Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.

" + } + }, + "documentation":"

The ConnectionDraining data type.

" + }, + "ConnectionDrainingEnabled":{"type":"boolean"}, + "ConnectionDrainingTimeout":{"type":"integer"}, + "ConnectionSettings":{ + "type":"structure", + "required":["IdleTimeout"], + "members":{ + "IdleTimeout":{ + "shape":"IdleTimeout", + "documentation":"

Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

" + } + }, + "documentation":"

The ConnectionSettings data type.

" + }, + "CookieExpirationPeriod":{"type":"long"}, + "CookieName":{"type":"string"}, + "CreateAccessPointInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Listeners" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer. The name must be unique within your set of load balancers, must have a maximum of 32 characters, and must only contain alphanumeric characters or hyphens.

" + }, + "Listeners":{ + "shape":"Listeners", + "documentation":"

A list of the following tuples: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

A list of Availability Zones.

At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones.

You can later add more Availability Zones after the creation of the load balancer by calling EnableAvailabilityZonesForLoadBalancer action.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The security groups to assign to your load balancer within your VPC.

" + }, + "Scheme":{ + "shape":"LoadBalancerScheme", + "documentation":"

The type of a load balancer.

By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers.

Specify the value internal for this option to create an internal load balancer with a DNS name that resolves to private IP addresses.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

" + } + }, + "documentation":"

The input for the CreateLoadBalancer action.

" + }, + "CreateAccessPointOutput":{ + "type":"structure", + "members":{ + "DNSName":{ + "shape":"DNSName", + "documentation":"

The DNS name for the load balancer.

" + } + }, + "documentation":"

The output for the CreateLoadBalancer action.

" + }, + "CreateAppCookieStickinessPolicyInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "PolicyName", + "CookieName" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy being created. The name must be unique within the set of policies for this load balancer.

" + }, + "CookieName":{ + "shape":"CookieName", + "documentation":"

Name of the application cookie used for stickiness.

" + } + }, + "documentation":"

The input for the CreateAppCookieStickinessPolicy action.

" + }, + "CreateAppCookieStickinessPolicyOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the CreateAppCookieStickinessPolicy action.

" + }, + "CreateLBCookieStickinessPolicyInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "PolicyName" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy being created. The name must be unique within the set of policies for this load balancer.

" + }, + "CookieExpirationPeriod":{ + "shape":"CookieExpirationPeriod", + "documentation":"

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

" + } + }, + "documentation":"

The input for the CreateLBCookieStickinessPolicy action.

" + }, + "CreateLBCookieStickinessPolicyOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the CreateLBCookieStickinessPolicy action.

" + }, + "CreateLoadBalancerListenerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Listeners" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Listeners":{ + "shape":"Listeners", + "documentation":"

A list of LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and SSLCertificateId items.

" + } + }, + "documentation":"

The input for the CreateLoadBalancerListeners action.

" + }, + "CreateLoadBalancerListenerOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the CreateLoadBalancerListeners action.

" + }, + "CreateLoadBalancerPolicyInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "PolicyName", + "PolicyTypeName" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the LoadBalancer for which the policy is being created.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the load balancer policy being created. The name must be unique within the set of policies for this load balancer.

" + }, + "PolicyTypeName":{ + "shape":"PolicyTypeName", + "documentation":"

The name of the base policy type being used to create this policy. To get the list of policy types, use the DescribeLoadBalancerPolicyTypes action.

" + }, + "PolicyAttributes":{ + "shape":"PolicyAttributes", + "documentation":"

A list of attributes associated with the policy being created.

" + } + } + }, + "CreateLoadBalancerPolicyOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the CreateLoadBalancerPolicy action.

" + }, + "CreatedTime":{"type":"timestamp"}, + "CrossZoneLoadBalancing":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"CrossZoneLoadBalancingEnabled", + "documentation":"

Specifies whether cross-zone load balancing is enabled for the load balancer.

" + } + }, + "documentation":"

The CrossZoneLoadBalancing data type.

" + }, + "CrossZoneLoadBalancingEnabled":{"type":"boolean"}, + "DNSName":{"type":"string"}, + "DefaultValue":{"type":"string"}, + "DeleteAccessPointInput":{ + "type":"structure", + "required":["LoadBalancerName"], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer.

" + } + }, + "documentation":"

The input for the DeleteLoadBalancer action.

" + }, + "DeleteAccessPointOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the DeleteLoadBalancer action.

" + }, + "DeleteLoadBalancerListenerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "LoadBalancerPorts" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The mnemonic name associated with the load balancer.

" + }, + "LoadBalancerPorts":{ + "shape":"Ports", + "documentation":"

The client port number(s) of the load balancer listener(s) to be removed.

" + } + }, + "documentation":"

The input for the DeleteLoadBalancerListeners action.

" + }, + "DeleteLoadBalancerListenerOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the DeleteLoadBalancerListeners action.

" + }, + "DeleteLoadBalancerPolicyInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "PolicyName" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The mnemonic name associated with the load balancer.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The mnemonic name for the policy being deleted.

" + } + }, + "documentation":"

The input for the DeleteLoadBalancerPolicy action.

" + }, + "DeleteLoadBalancerPolicyOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the DeleteLoadBalancerPolicy action.

" + }, + "DeregisterEndPointsInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Instances" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

A list of EC2 instance IDs consisting of all instances to be deregistered.

" + } + }, + "documentation":"

The input for the DeregisterInstancesFromLoadBalancer action.

" + }, + "DeregisterEndPointsOutput":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"Instances", + "documentation":"

An updated list of remaining instances registered with the load balancer.

" + } + }, + "documentation":"

The output for the DeregisterInstancesFromLoadBalancer action.

" + }, + "DescribeAccessPointsInput":{ + "type":"structure", + "members":{ + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

A list of load balancer names associated with the account.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

An optional parameter used for pagination of results from this call. If specified, the response includes only records beyond the marker.

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The number of results returned in each page. The default is 400. You cannot specify a page size greater than 400 or less than 1.

" + } + }, + "documentation":"

The input for the DescribeLoadBalancers action.

" + }, + "DescribeAccessPointsOutput":{ + "type":"structure", + "members":{ + "LoadBalancerDescriptions":{ + "shape":"LoadBalancerDescriptions", + "documentation":"

A list of load balancer description structures.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

Specifies the value of next marker if the request returned more than one page of results.

" + } + }, + "documentation":"

The output for the DescribeLoadBalancers action.

" + }, + "DescribeEndPointStateInput":{ + "type":"structure", + "required":["LoadBalancerName"], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

A list of instance IDs whose states are being queried.

" + } + }, + "documentation":"

The input for the DescribeEndPointState action.

" + }, + "DescribeEndPointStateOutput":{ + "type":"structure", + "members":{ + "InstanceStates":{ + "shape":"InstanceStates", + "documentation":"

A list containing health information for the specified instances.

" + } + }, + "documentation":"

The output for the DescribeInstanceHealth action.

" + }, + "DescribeLoadBalancerAttributesInput":{ + "type":"structure", + "required":["LoadBalancerName"], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + } + }, + "documentation":"

The input for the DescribeLoadBalancerAttributes action.

" + }, + "DescribeLoadBalancerAttributesOutput":{ + "type":"structure", + "members":{ + "LoadBalancerAttributes":{ + "shape":"LoadBalancerAttributes", + "documentation":"

The load balancer attributes structure.

" + } + }, + "documentation":"

The following element is returned in a structure named DescribeLoadBalancerAttributesResult.

" + }, + "DescribeLoadBalancerPoliciesInput":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The mnemonic name associated with the load balancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

The names of load balancer policies you've created or Elastic Load Balancing sample policy names.

" + } + } + }, + "DescribeLoadBalancerPoliciesOutput":{ + "type":"structure", + "members":{ + "PolicyDescriptions":{ + "shape":"PolicyDescriptions", + "documentation":"

A list of policy description structures.

" + } + }, + "documentation":"

The output for the DescribeLoadBalancerPolicies action.

" + }, + "DescribeLoadBalancerPolicyTypesInput":{ + "type":"structure", + "members":{ + "PolicyTypeNames":{ + "shape":"PolicyTypeNames", + "documentation":"

Specifies the name of the policy types. If no names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.

" + } + } + }, + "DescribeLoadBalancerPolicyTypesOutput":{ + "type":"structure", + "members":{ + "PolicyTypeDescriptions":{ + "shape":"PolicyTypeDescriptions", + "documentation":"

List of policy type description structures of the specified policy type. If no policy type names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.

" + } + }, + "documentation":"

The output for the DescribeLoadBalancerPolicyTypes action.

" + }, + "DescribeTagsInput":{ + "type":"structure", + "required":["LoadBalancerNames"], + "members":{ + "LoadBalancerNames":{ + "shape":"LoadBalancerNamesMax20", + "documentation":"

The names of the load balancers.

" + } + }, + "documentation":"

The input for the DescribeTags action.

" + }, + "DescribeTagsOutput":{ + "type":"structure", + "members":{ + "TagDescriptions":{ + "shape":"TagDescriptions", + "documentation":"

A list of tag description structures.

" + } + }, + "documentation":"

The output for the DescribeTags action.

" + }, + "Description":{"type":"string"}, + "DetachLoadBalancerFromSubnetsInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Subnets" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer to be detached.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

A list of subnet IDs to remove from the set of configured subnets for the load balancer.

" + } + }, + "documentation":"

The input for the DetachLoadBalancerFromSubnets action.

" + }, + "DetachLoadBalancerFromSubnetsOutput":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"Subnets", + "documentation":"

A list of subnet IDs the load balancer is now attached to.

" + } + }, + "documentation":"

The output for the DetachLoadBalancerFromSubnets action.

" + }, + "DuplicateAccessPointNameException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DuplicateLoadBalancerName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The load balancer name already exists for this account. Please choose another name.

" + }, + "DuplicateListenerException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DuplicateListener", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A Listener already exists for the given LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId.

" + }, + "DuplicatePolicyNameException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DuplicatePolicyName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Policy with the same name exists for this load balancer. Please choose another name.

" + }, + "DuplicateTagKeysException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DuplicateTagKeys", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The same tag key specified multiple times.

" + }, + "EndPointPort":{"type":"integer"}, + "HealthCheck":{ + "type":"structure", + "required":[ + "Target", + "Interval", + "Timeout", + "UnhealthyThreshold", + "HealthyThreshold" + ], + "members":{ + "Target":{ + "shape":"HealthCheckTarget", + "documentation":"

Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

" + }, + "Interval":{ + "shape":"HealthCheckInterval", + "documentation":"

Specifies the approximate interval, in seconds, between health checks of an individual instance.

" + }, + "Timeout":{ + "shape":"HealthCheckTimeout", + "documentation":"

Specifies the amount of time, in seconds, during which no response means a failed health probe.

" + }, + "UnhealthyThreshold":{ + "shape":"UnhealthyThreshold", + "documentation":"

Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

" + }, + "HealthyThreshold":{ + "shape":"HealthyThreshold", + "documentation":"

Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

" + } + }, + "documentation":"

The HealthCheck data type.

" + }, + "HealthCheckInterval":{ + "type":"integer", + "min":1, + "max":300 + }, + "HealthCheckTarget":{"type":"string"}, + "HealthCheckTimeout":{ + "type":"integer", + "min":1, + "max":300 + }, + "HealthyThreshold":{ + "type":"integer", + "min":2, + "max":10 + }, + "IdleTimeout":{ + "type":"integer", + "min":1, + "max":3600 + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

Provides an EC2 instance ID.

" + } + }, + "documentation":"

The Instance data type.

" + }, + "InstanceId":{"type":"string"}, + "InstancePort":{ + "type":"integer", + "min":1, + "max":65535 + }, + "InstanceState":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

Provides an EC2 instance ID.

" + }, + "State":{ + "shape":"State", + "documentation":"

Specifies the current state of the instance.

Valid value: InService|OutOfService|Unknown

" + }, + "ReasonCode":{ + "shape":"ReasonCode", + "documentation":"

Provides information about the cause of OutOfService instances. Specifically, it indicates whether the cause is Elastic Load Balancing or the instance behind the load balancer.

Valid value: ELB|Instance|N/A

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Provides a description of the instance state.

" + } + }, + "documentation":"

The InstanceState data type.

" + }, + "InstanceStates":{ + "type":"list", + "member":{"shape":"InstanceState"} + }, + "Instances":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InvalidConfigurationRequestException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Requested configuration change is invalid.

" + }, + "InvalidEndPointException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidInstance", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified EndPoint is not valid.

" + }, + "InvalidSchemeException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidScheme", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Invalid value for scheme. Scheme can only be specified for load balancers in VPC.

" + }, + "InvalidSecurityGroupException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more specified security groups do not exist.

" + }, + "InvalidSubnetException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC has no Internet gateway.

" + }, + "LBCookieStickinessPolicies":{ + "type":"list", + "member":{"shape":"LBCookieStickinessPolicy"} + }, + "LBCookieStickinessPolicy":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name for the policy being created. The name must be unique within the set of policies for this load balancer.

" + }, + "CookieExpirationPeriod":{ + "shape":"CookieExpirationPeriod", + "documentation":"

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session.

" + } + }, + "documentation":"

The LBCookieStickinessPolicy data type.

" + }, + "Listener":{ + "type":"structure", + "required":[ + "Protocol", + "LoadBalancerPort", + "InstancePort" + ], + "members":{ + "Protocol":{ + "shape":"Protocol", + "documentation":"

Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.

" + }, + "LoadBalancerPort":{ + "shape":"AccessPointPort", + "documentation":"

Specifies the external load balancer port number. This property cannot be modified for the life of the load balancer.

" + }, + "InstanceProtocol":{ + "shape":"Protocol", + "documentation":"

Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer.

" + }, + "InstancePort":{ + "shape":"InstancePort", + "documentation":"

Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life of the load balancer.

" + }, + "SSLCertificateId":{ + "shape":"SSLCertificateId", + "documentation":"

The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.

" + } + }, + "documentation":"

The Listener data type.

" + }, + "ListenerDescription":{ + "type":"structure", + "members":{ + "Listener":{"shape":"Listener"}, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

A list of policies enabled for this listener. An empty list indicates that no policies are enabled.

" + } + }, + "documentation":"

The ListenerDescription data type.

" + }, + "ListenerDescriptions":{ + "type":"list", + "member":{"shape":"ListenerDescription"} + }, + "ListenerNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ListenerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Load balancer does not have a listener configured at the given port.

" + }, + "Listeners":{ + "type":"list", + "member":{"shape":"Listener"} + }, + "LoadBalancerAttributeNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"LoadBalancerAttributeNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified load balancer attribute could not be found.

" + }, + "LoadBalancerAttributes":{ + "type":"structure", + "members":{ + "CrossZoneLoadBalancing":{ + "shape":"CrossZoneLoadBalancing", + "documentation":"

The name of the load balancer attribute. If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.

For more information, see Enable Cross-Zone Load Balancing.

" + }, + "AccessLog":{ + "shape":"AccessLog", + "documentation":"

The name of the load balancer attribute. If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.

For more information, see Enable Access Logs.

" + }, + "ConnectionDraining":{ + "shape":"ConnectionDraining", + "documentation":"

The name of the load balancer attribute. If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.

For more information, see Enable Connection Draining.

" + }, + "ConnectionSettings":{ + "shape":"ConnectionSettings", + "documentation":"

The name of the load balancer attribute.

By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to remain idle (no data is sent over the connection) for the specified duration.

For more information, see Configure Idle Connection Timeout.

" + } + }, + "documentation":"

The LoadBalancerAttributes data type.

" + }, + "LoadBalancerDescription":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

Specifies the name associated with the load balancer.

" + }, + "DNSName":{ + "shape":"DNSName", + "documentation":"

Specifies the external DNS name associated with the load balancer.

" + }, + "CanonicalHostedZoneName":{ + "shape":"DNSName", + "documentation":"

Provides the name of the Amazon Route 53 hosted zone that is associated with the load balancer. For information on how to associate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

" + }, + "CanonicalHostedZoneNameID":{ + "shape":"DNSName", + "documentation":"

Provides the ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. For information on how to associate or disassociate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

" + }, + "ListenerDescriptions":{ + "shape":"ListenerDescriptions", + "documentation":"

LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned in a list of tuples in the ListenerDescriptions element.

" + }, + "Policies":{ + "shape":"Policies", + "documentation":"

Provides a list of policies defined for the load balancer.

" + }, + "BackendServerDescriptions":{ + "shape":"BackendServerDescriptions", + "documentation":"

Contains a list of back-end server descriptions.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Specifies a list of Availability Zones.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

Provides a list of VPC subnet IDs for the load balancer.

" + }, + "VPCId":{ + "shape":"VPCId", + "documentation":"

Provides the ID of the VPC attached to the load balancer.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

Provides a list of EC2 instance IDs for the load balancer.

" + }, + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

Specifies information regarding the various health probes conducted on the load balancer.

" + }, + "SourceSecurityGroup":{ + "shape":"SourceSecurityGroup", + "documentation":"

The security group that you can use as part of your inbound rules for your load balancer's back-end Amazon EC2 application instances. To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this source security group as the inbound source.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The security groups the load balancer is a member of (VPC only).

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

Provides the date and time the load balancer was created.

" + }, + "Scheme":{ + "shape":"LoadBalancerScheme", + "documentation":"

Specifies the type of load balancer.

If the Scheme is internet-facing, the load balancer has a publicly resolvable DNS name that resolves to public IP addresses.

If the Scheme is internal, the load balancer has a publicly resolvable DNS name that resolves to private IP addresses.

This option is only available for load balancers attached to an Amazon VPC.

" + } + }, + "documentation":"

Contains the result of a successful invocation of DescribeLoadBalancers.

" + }, + "LoadBalancerDescriptions":{ + "type":"list", + "member":{"shape":"LoadBalancerDescription"} + }, + "LoadBalancerNames":{ + "type":"list", + "member":{"shape":"AccessPointName"} + }, + "LoadBalancerNamesMax20":{ + "type":"list", + "member":{"shape":"AccessPointName"}, + "min":1, + "max":20 + }, + "LoadBalancerScheme":{"type":"string"}, + "Marker":{"type":"string"}, + "ModifyLoadBalancerAttributesInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "LoadBalancerAttributes" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerAttributes":{ + "shape":"LoadBalancerAttributes", + "documentation":"

Attributes of the load balancer.

" + } + }, + "documentation":"

The input for the ModifyLoadBalancerAttributes action.

" + }, + "ModifyLoadBalancerAttributesOutput":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerAttributes":{"shape":"LoadBalancerAttributes"} + }, + "documentation":"

The output for the ModifyLoadBalancerAttributes action.

" + }, + "PageSize":{ + "type":"integer", + "min":1, + "max":400 + }, + "Policies":{ + "type":"structure", + "members":{ + "AppCookieStickinessPolicies":{ + "shape":"AppCookieStickinessPolicies", + "documentation":"

A list of the AppCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.

" + }, + "LBCookieStickinessPolicies":{ + "shape":"LBCookieStickinessPolicies", + "documentation":"

A list of LBCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.

" + }, + "OtherPolicies":{ + "shape":"PolicyNames", + "documentation":"

A list of policy names other than the stickiness policies.

" + } + }, + "documentation":"

The policies data type.

" + }, + "PolicyAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute associated with the policy.

" + }, + "AttributeValue":{ + "shape":"AttributeValue", + "documentation":"

The value of the attribute associated with the policy.

" + } + }, + "documentation":"

The PolicyAttribute data type. This data type contains a key/value pair that defines properties of a specific policy.

" + }, + "PolicyAttributeDescription":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute associated with the policy.

" + }, + "AttributeValue":{ + "shape":"AttributeValue", + "documentation":"

The value of the attribute associated with the policy.

" + } + }, + "documentation":"

The PolicyAttributeDescription data type. This data type is used to describe the attributes and values associated with a policy.

" + }, + "PolicyAttributeDescriptions":{ + "type":"list", + "member":{"shape":"PolicyAttributeDescription"} + }, + "PolicyAttributeTypeDescription":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute associated with the policy type.

" + }, + "AttributeType":{ + "shape":"AttributeType", + "documentation":"

The type of attribute. For example, Boolean, Integer, etc.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A human-readable description of the attribute.

" + }, + "DefaultValue":{ + "shape":"DefaultValue", + "documentation":"

The default value of the attribute, if applicable.

" + }, + "Cardinality":{ + "shape":"Cardinality", + "documentation":"

The cardinality of the attribute. Valid Values:

" + } + }, + "documentation":"

The PolicyAttributeTypeDescription data type. This data type is used to describe values that are acceptable for the policy attribute.

" + }, + "PolicyAttributeTypeDescriptions":{ + "type":"list", + "member":{"shape":"PolicyAttributeTypeDescription"} + }, + "PolicyAttributes":{ + "type":"list", + "member":{"shape":"PolicyAttribute"} + }, + "PolicyDescription":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy associated with the load balancer.

" + }, + "PolicyTypeName":{ + "shape":"PolicyTypeName", + "documentation":"

The name of the policy type associated with the load balancer.

" + }, + "PolicyAttributeDescriptions":{ + "shape":"PolicyAttributeDescriptions", + "documentation":"

A list of policy attribute description structures.

" + } + }, + "documentation":"

The PolicyDescription data type.

" + }, + "PolicyDescriptions":{ + "type":"list", + "member":{"shape":"PolicyDescription"} + }, + "PolicyName":{"type":"string"}, + "PolicyNames":{ + "type":"list", + "member":{"shape":"PolicyName"} + }, + "PolicyNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PolicyNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more specified policies were not found.

" + }, + "PolicyTypeDescription":{ + "type":"structure", + "members":{ + "PolicyTypeName":{ + "shape":"PolicyTypeName", + "documentation":"

The name of the policy type.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A human-readable description of the policy type.

" + }, + "PolicyAttributeTypeDescriptions":{ + "shape":"PolicyAttributeTypeDescriptions", + "documentation":"

The description of the policy attributes associated with the load balancer policies defined by the Elastic Load Balancing service.

" + } + }, + "documentation":"

The PolicyTypeDescription data type.

" + }, + "PolicyTypeDescriptions":{ + "type":"list", + "member":{"shape":"PolicyTypeDescription"} + }, + "PolicyTypeName":{"type":"string"}, + "PolicyTypeNames":{ + "type":"list", + "member":{"shape":"PolicyTypeName"} + }, + "PolicyTypeNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PolicyTypeNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more of the specified policy types do not exist.

" + }, + "Ports":{ + "type":"list", + "member":{"shape":"AccessPointPort"} + }, + "Protocol":{"type":"string"}, + "ReasonCode":{"type":"string"}, + "RegisterEndPointsInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Instances" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer. The name must be unique within your set of load balancers.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

A list of instance IDs that should be registered with the load balancer.

" + } + }, + "documentation":"

The input for the RegisterInstancesWithLoadBalancer action.

" + }, + "RegisterEndPointsOutput":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"Instances", + "documentation":"

An updated list of instances for the load balancer.

" + } + }, + "documentation":"

The output for the RegisterInstancesWithLoadBalancer action.

" + }, + "RemoveAvailabilityZonesInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "AvailabilityZones" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name associated with the load balancer.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

A list of Availability Zones to be removed from the load balancer.

" + } + }, + "documentation":"

The input for the DisableAvailabilityZonesForLoadBalancer action.

" + }, + "RemoveAvailabilityZonesOutput":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

A list of updated Availability Zones for the load balancer.

" + } + }, + "documentation":"

The output for the DisableAvailabilityZonesForLoadBalancer action.

" + }, + "RemoveTagsInput":{ + "type":"structure", + "required":[ + "LoadBalancerNames", + "Tags" + ], + "members":{ + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

The name of the load balancer. You can specify a maximum of one load balancer name.

" + }, + "Tags":{ + "shape":"TagKeyList", + "documentation":"

A list of tag keys to remove.

" + } + }, + "documentation":"

The input for the RemoveTags action.

" + }, + "RemoveTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the RemoveTags action.

" + }, + "S3BucketName":{"type":"string"}, + "SSLCertificateId":{"type":"string"}, + "SecurityGroupId":{"type":"string"}, + "SecurityGroupName":{"type":"string"}, + "SecurityGroupOwnerAlias":{"type":"string"}, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroupId"} + }, + "SetLoadBalancerListenerSSLCertificateInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "LoadBalancerPort", + "SSLCertificateId" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerPort":{ + "shape":"AccessPointPort", + "documentation":"

The port that uses the specified SSL certificate.

" + }, + "SSLCertificateId":{ + "shape":"SSLCertificateId", + "documentation":"

The Amazon Resource Number (ARN) of the SSL certificate chain to use. For more information on SSL certificates, see Managing Server Certificates in the AWS Identity and Access Management User Guide.

" + } + }, + "documentation":"

The input for the SetLoadBalancerListenerSSLCertificate action.

" + }, + "SetLoadBalancerListenerSSLCertificateOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the SetLoadBalancerListenerSSLCertificate action.

" + }, + "SetLoadBalancerPoliciesForBackendServerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "InstancePort", + "PolicyNames" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The mnemonic name associated with the load balancer. This name must be unique within the set of your load balancers.

" + }, + "InstancePort":{ + "shape":"EndPointPort", + "documentation":"

The port number associated with the back-end server.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

List of policy names to be set. If the list is empty, then all current polices are removed from the back-end server.

" + } + }, + "documentation":"

The input for the SetLoadBalancerPoliciesForBackendServer action.

" + }, + "SetLoadBalancerPoliciesForBackendServerOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the SetLoadBalancerPoliciesForBackendServer action.

" + }, + "SetLoadBalancerPoliciesOfListenerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "LoadBalancerPort", + "PolicyNames" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerPort":{ + "shape":"AccessPointPort", + "documentation":"

The external port of the load balancer to associate the policy.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

List of policies to be associated with the listener. If the list is empty, the current policy is removed from the listener.

" + } + }, + "documentation":"

The input for the SetLoadBalancerPoliciesOfListener action.

" + }, + "SetLoadBalancerPoliciesOfListenerOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the SetLoadBalancerPoliciesOfListener action.

" + }, + "SourceSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerAlias":{ + "shape":"SecurityGroupOwnerAlias", + "documentation":"

Owner of the source security group. Use this value for the --source-group-user parameter of the ec2-authorize command in the Amazon EC2 command line tool.

" + }, + "GroupName":{ + "shape":"SecurityGroupName", + "documentation":"

Name of the source security group. Use this value for the --source-group parameter of the ec2-authorize command in the Amazon EC2 command line tool.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeLoadBalancers action. For information about Elastic Load Balancing security groups, go to Using Security Groups With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

" + }, + "State":{"type":"string"}, + "SubnetId":{"type":"string"}, + "SubnetNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

One or more subnets were not found.

" + }, + "Subnets":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

Metadata assigned to a load balancer consisting of key-value pair.

For more information, see Tagging in the Elastic Load Balancing Developer Guide.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

List of tags associated with the load balancer.

" + } + }, + "documentation":"

The descriptions of all the tags associated with load balancer.

" + }, + "TagDescriptions":{ + "type":"list", + "member":{"shape":"TagDescription"} + }, + "TagKey":{ + "type":"string", + "min":1, + "max":128, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKeyOnly"}, + "min":1 + }, + "TagKeyOnly":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The name of the key.

" + } + }, + "documentation":"

The key of a tag to be removed.

" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":1 + }, + "TagValue":{ + "type":"string", + "min":0, + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TooManyAccessPointsException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TooManyLoadBalancers", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for the number of load balancers has already been reached.

" + }, + "TooManyPoliciesException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TooManyPolicies", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Quota for number of policies for this load balancer has already been reached.

" + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TooManyTags", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota for the number of tags that can be assigned to a load balancer has been reached.

" + }, + "UnhealthyThreshold":{ + "type":"integer", + "min":2, + "max":10 + }, + "VPCId":{"type":"string"} + } +} diff --git a/apis/elasticloadbalancing-2012-06-01.paginators.json b/apis/elasticloadbalancing-2012-06-01.paginators.json new file mode 100644 index 0000000000..82113a7066 --- /dev/null +++ b/apis/elasticloadbalancing-2012-06-01.paginators.json @@ -0,0 +1,18 @@ +{ + "pagination": { + "DescribeInstanceHealth": { + "result_key": "InstanceStates" + }, + "DescribeLoadBalancerPolicies": { + "result_key": "PolicyDescriptions" + }, + "DescribeLoadBalancerPolicyTypes": { + "result_key": "PolicyTypeDescriptions" + }, + "DescribeLoadBalancers": { + "input_token": "Marker", + "output_token": "NextMarker", + "result_key": "LoadBalancerDescriptions" + } + } +} diff --git a/apis/elasticmapreduce-2009-03-31.api.json b/apis/elasticmapreduce-2009-03-31.api.json new file mode 100644 index 0000000000..d850c05670 --- /dev/null +++ b/apis/elasticmapreduce-2009-03-31.api.json @@ -0,0 +1,965 @@ +{ + "metadata": { + "apiVersion": "2009-03-31", + "endpointPrefix": "elasticmapreduce", + "jsonVersion": "1.1", + "serviceAbbreviation": "Amazon EMR", + "serviceFullName": "Amazon Elastic MapReduce", + "signatureVersion": "v4", + "targetPrefix": "ElasticMapReduce", + "timestampFormat": "unixTimestamp", + "protocol": "json" + }, + "operations": { + "AddInstanceGroups": { + "input": { + "type": "structure", + "required": [ + "InstanceGroups", + "JobFlowId" + ], + "members": { + "InstanceGroups": { + "shape": "S2" + }, + "JobFlowId": {} + } + }, + "output": { + "type": "structure", + "members": { + "JobFlowId": {}, + "InstanceGroupIds": { + "type": "list", + "member": {} + } + } + } + }, + "AddJobFlowSteps": { + "input": { + "type": "structure", + "required": [ + "JobFlowId", + "Steps" + ], + "members": { + "JobFlowId": {}, + "Steps": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "StepIds": { + "type": "list", + "member": {} + } + } + } + }, + "AddTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "Tags" + ], + "members": { + "ResourceId": {}, + "Tags": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Cluster": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Status": { + "shape": "Sw" + }, + "Ec2InstanceAttributes": { + "type": "structure", + "members": { + "Ec2KeyName": {}, + "Ec2SubnetId": {}, + "Ec2AvailabilityZone": {}, + "IamInstanceProfile": {} + } + }, + "LogUri": {}, + "RequestedAmiVersion": {}, + "RunningAmiVersion": {}, + "AutoTerminate": { + "type": "boolean" + }, + "TerminationProtected": { + "type": "boolean" + }, + "VisibleToAllUsers": { + "type": "boolean" + }, + "Applications": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Version": {}, + "Args": { + "shape": "S16" + }, + "AdditionalInfo": { + "shape": "S17" + } + } + } + }, + "Tags": { + "shape": "So" + }, + "ServiceRole": {} + } + } + } + } + }, + "DescribeJobFlows": { + "input": { + "type": "structure", + "members": { + "CreatedAfter": { + "type": "timestamp" + }, + "CreatedBefore": { + "type": "timestamp" + }, + "JobFlowIds": { + "shape": "Sj" + }, + "JobFlowStates": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "JobFlows": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "JobFlowId", + "Name", + "ExecutionStatusDetail", + "Instances" + ], + "members": { + "JobFlowId": {}, + "Name": {}, + "LogUri": {}, + "AmiVersion": {}, + "ExecutionStatusDetail": { + "type": "structure", + "required": [ + "State", + "CreationDateTime" + ], + "members": { + "State": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "StartDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + }, + "LastStateChangeReason": {} + } + }, + "Instances": { + "type": "structure", + "required": [ + "MasterInstanceType", + "SlaveInstanceType", + "InstanceCount" + ], + "members": { + "MasterInstanceType": {}, + "MasterPublicDnsName": {}, + "MasterInstanceId": {}, + "SlaveInstanceType": {}, + "InstanceCount": { + "type": "integer" + }, + "InstanceGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Market", + "InstanceRole", + "InstanceType", + "InstanceRequestCount", + "InstanceRunningCount", + "State", + "CreationDateTime" + ], + "members": { + "InstanceGroupId": {}, + "Name": {}, + "Market": {}, + "InstanceRole": {}, + "BidPrice": {}, + "InstanceType": {}, + "InstanceRequestCount": { + "type": "integer" + }, + "InstanceRunningCount": { + "type": "integer" + }, + "State": {}, + "LastStateChangeReason": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "StartDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + }, + "NormalizedInstanceHours": { + "type": "integer" + }, + "Ec2KeyName": {}, + "Ec2SubnetId": {}, + "Placement": { + "shape": "S1j" + }, + "KeepJobFlowAliveWhenNoSteps": { + "type": "boolean" + }, + "TerminationProtected": { + "type": "boolean" + }, + "HadoopVersion": {} + } + }, + "Steps": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "StepConfig", + "ExecutionStatusDetail" + ], + "members": { + "StepConfig": { + "shape": "Sd" + }, + "ExecutionStatusDetail": { + "type": "structure", + "required": [ + "State", + "CreationDateTime" + ], + "members": { + "State": {}, + "CreationDateTime": { + "type": "timestamp" + }, + "StartDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + }, + "LastStateChangeReason": {} + } + } + } + } + }, + "BootstrapActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "BootstrapActionConfig": { + "shape": "S1q" + } + } + } + }, + "SupportedProducts": { + "shape": "S1s" + }, + "VisibleToAllUsers": { + "type": "boolean" + }, + "JobFlowRole": {}, + "ServiceRole": {} + } + } + } + } + }, + "deprecated": true + }, + "DescribeStep": { + "input": { + "type": "structure", + "required": [ + "ClusterId", + "StepId" + ], + "members": { + "ClusterId": {}, + "StepId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Step": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Config": { + "type": "structure", + "members": { + "Jar": {}, + "Properties": { + "shape": "S17" + }, + "MainClass": {}, + "Args": { + "shape": "S16" + } + } + }, + "ActionOnFailure": {}, + "Status": { + "shape": "S1y" + } + } + } + } + } + }, + "ListBootstrapActions": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "BootstrapActions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "ScriptPath": {}, + "Args": { + "shape": "S16" + } + } + } + }, + "Marker": {} + } + } + }, + "ListClusters": { + "input": { + "type": "structure", + "members": { + "CreatedAfter": { + "type": "timestamp" + }, + "CreatedBefore": { + "type": "timestamp" + }, + "ClusterStates": { + "type": "list", + "member": {} + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Clusters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Status": { + "shape": "Sw" + } + } + } + }, + "Marker": {} + } + } + }, + "ListInstanceGroups": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Market": {}, + "InstanceGroupType": {}, + "BidPrice": {}, + "InstanceType": {}, + "RequestedInstanceCount": { + "type": "integer" + }, + "RunningInstanceCount": { + "type": "integer" + }, + "Status": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "ListInstances": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "InstanceGroupId": {}, + "InstanceGroupTypes": { + "type": "list", + "member": {} + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Ec2InstanceId": {}, + "PublicDnsName": {}, + "PublicIpAddress": {}, + "PrivateDnsName": {}, + "PrivateIpAddress": {}, + "Status": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "ListSteps": { + "input": { + "type": "structure", + "required": [ + "ClusterId" + ], + "members": { + "ClusterId": {}, + "StepStates": { + "type": "list", + "member": {} + }, + "Marker": {} + } + }, + "output": { + "type": "structure", + "members": { + "Steps": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Status": { + "shape": "S1y" + } + } + } + }, + "Marker": {} + } + } + }, + "ModifyInstanceGroups": { + "input": { + "type": "structure", + "members": { + "InstanceGroups": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceGroupId" + ], + "members": { + "InstanceGroupId": {}, + "InstanceCount": { + "type": "integer" + }, + "EC2InstanceIdsToTerminate": { + "type": "list", + "member": {} + } + } + } + } + } + } + }, + "RemoveTags": { + "input": { + "type": "structure", + "required": [ + "ResourceId", + "TagKeys" + ], + "members": { + "ResourceId": {}, + "TagKeys": { + "shape": "S16" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "RunJobFlow": { + "input": { + "type": "structure", + "required": [ + "Name", + "Instances" + ], + "members": { + "Name": {}, + "LogUri": {}, + "AdditionalInfo": {}, + "AmiVersion": {}, + "Instances": { + "type": "structure", + "members": { + "MasterInstanceType": {}, + "SlaveInstanceType": {}, + "InstanceCount": { + "type": "integer" + }, + "InstanceGroups": { + "shape": "S2" + }, + "Ec2KeyName": {}, + "Placement": { + "shape": "S1j" + }, + "KeepJobFlowAliveWhenNoSteps": { + "type": "boolean" + }, + "TerminationProtected": { + "type": "boolean" + }, + "HadoopVersion": {}, + "Ec2SubnetId": {} + } + }, + "Steps": { + "shape": "Sc" + }, + "BootstrapActions": { + "type": "list", + "member": { + "shape": "S1q" + } + }, + "SupportedProducts": { + "shape": "S1s" + }, + "NewSupportedProducts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Args": { + "shape": "Sj" + } + } + } + }, + "VisibleToAllUsers": { + "type": "boolean" + }, + "JobFlowRole": {}, + "ServiceRole": {}, + "Tags": { + "shape": "So" + } + } + }, + "output": { + "type": "structure", + "members": { + "JobFlowId": {} + } + } + }, + "SetTerminationProtection": { + "input": { + "type": "structure", + "required": [ + "JobFlowIds", + "TerminationProtected" + ], + "members": { + "JobFlowIds": { + "shape": "Sj" + }, + "TerminationProtected": { + "type": "boolean" + } + } + } + }, + "SetVisibleToAllUsers": { + "input": { + "type": "structure", + "required": [ + "JobFlowIds", + "VisibleToAllUsers" + ], + "members": { + "JobFlowIds": { + "shape": "Sj" + }, + "VisibleToAllUsers": { + "type": "boolean" + } + } + } + }, + "TerminateJobFlows": { + "input": { + "type": "structure", + "required": [ + "JobFlowIds" + ], + "members": { + "JobFlowIds": { + "shape": "Sj" + } + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "InstanceRole", + "InstanceType", + "InstanceCount" + ], + "members": { + "Name": {}, + "Market": {}, + "InstanceRole": {}, + "BidPrice": {}, + "InstanceType": {}, + "InstanceCount": { + "type": "integer" + } + } + } + }, + "Sc": { + "type": "list", + "member": { + "shape": "Sd" + } + }, + "Sd": { + "type": "structure", + "required": [ + "Name", + "HadoopJarStep" + ], + "members": { + "Name": {}, + "ActionOnFailure": {}, + "HadoopJarStep": { + "type": "structure", + "required": [ + "Jar" + ], + "members": { + "Properties": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Jar": {}, + "MainClass": {}, + "Args": { + "shape": "Sj" + } + } + } + } + }, + "Sj": { + "type": "list", + "member": {} + }, + "So": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sw": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "ReadyDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + }, + "S16": { + "type": "list", + "member": {} + }, + "S17": { + "type": "map", + "key": {}, + "value": {} + }, + "S1j": { + "type": "structure", + "required": [ + "AvailabilityZone" + ], + "members": { + "AvailabilityZone": {} + } + }, + "S1q": { + "type": "structure", + "required": [ + "Name", + "ScriptBootstrapAction" + ], + "members": { + "Name": {}, + "ScriptBootstrapAction": { + "type": "structure", + "required": [ + "Path" + ], + "members": { + "Path": {}, + "Args": { + "shape": "Sj" + } + } + } + } + }, + "S1s": { + "type": "list", + "member": {} + }, + "S1y": { + "type": "structure", + "members": { + "State": {}, + "StateChangeReason": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + }, + "Timeline": { + "type": "structure", + "members": { + "CreationDateTime": { + "type": "timestamp" + }, + "StartDateTime": { + "type": "timestamp" + }, + "EndDateTime": { + "type": "timestamp" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/apis/elasticmapreduce-2009-03-31.full.json b/apis/elasticmapreduce-2009-03-31.full.json new file mode 100644 index 0000000000..0da7caca3b --- /dev/null +++ b/apis/elasticmapreduce-2009-03-31.full.json @@ -0,0 +1,2282 @@ +{ + "metadata":{ + "apiVersion":"2009-03-31", + "endpointPrefix":"elasticmapreduce", + "jsonVersion":"1.1", + "serviceAbbreviation":"Amazon EMR", + "serviceFullName":"Amazon Elastic MapReduce", + "signatureVersion":"v4", + "targetPrefix":"ElasticMapReduce", + "timestampFormat":"unixTimestamp", + "protocol":"json" + }, + "documentation":"

This is the Amazon Elastic MapReduce API Reference. This guide provides descriptions and\n samples of the Amazon Elastic MapReduce APIs.

\n\n

Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of\n data efficiently. Amazon EMR uses Hadoop processing combined with several AWS\n products to do tasks such as web indexing, data mining, log file analysis, machine\n learning, scientific simulation, and data warehousing.

", + "operations":{ + "AddInstanceGroups":{ + "name":"AddInstanceGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddInstanceGroupsInput", + "documentation":"

Input to an AddInstanceGroups call.

" + }, + "output":{ + "shape":"AddInstanceGroupsOutput", + "documentation":"

Output from an AddInstanceGroups call.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + } + ], + "documentation":"

AddInstanceGroups adds an instance group to a running cluster.

\n\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.AddInstanceGroups\nContent-Length: 168\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130715T223346Z\nX-Amz-Content-Sha256: ac5a7193b1283898dd822a4b16ca36963879bb010d2dbe57198439973ab2a7d3\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=4c5e7eb762ea45f292a5cd1a1cc56ed60009e19a9dba3d6e5e4e67e96d43af11\nAccept: */*\n\n\n{\n \"JobFlowId\": \"j-3U7TSX5GZFD8Y\",\n \"InstanceGroups\": [{\n \"Name\": \"Task Instance Group\",\n \"InstanceRole\": \"TASK\",\n \"InstanceCount\": 2,\n \"InstanceType\": \"m1.small\",\n \"Market\": \"ON_DEMAND\"\n }]\n}\n\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8d\nContent-Type: application/x-amz-json-1.1\nContent-Length: 71\nDate: Mon, 15 Jul 2013 22:33:47 GMT\n\n{\n \"InstanceGroupIds\": [\"ig-294A6A2KWT4WB\"],\n \"JobFlowId\": \"j-3U7TSX5GZFD8Y\"\n}\n\n\n " + }, + "AddJobFlowSteps":{ + "name":"AddJobFlowSteps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddJobFlowStepsInput", + "documentation":"

The input argument to the AddJobFlowSteps operation.

" + }, + "output":{ + "shape":"AddJobFlowStepsOutput", + "documentation":"

The output for the AddJobFlowSteps operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + } + ], + "documentation":"

AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed\n in each job flow.

\n

If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.

\n

A step specifies the location of a JAR file stored either on the master node of the job\n flow or in Amazon S3. Each step is performed by the main function of the main class of the\n JAR file. The main class can be specified either in the manifest of the JAR or by using the\n MainFunction parameter of the step.

\n

Elastic MapReduce executes each step in the order listed. For a step to be considered\n complete, the main function must exit with a zero exit code and all Hadoop jobs started\n while the step was running must have completed and run successfully.

\n

You can only add steps to a job flow that is in one of the following states: STARTING,\n BOOTSTRAPPING, RUNNING, or WAITING.

\n\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.AddJobFlowSteps\nContent-Length: 426\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130716T210948Z\nX-Amz-Content-Sha256: 9e5ad0a93c22224947ce98eea94f766103d91b28fa82eb60d0cb8b6f9555a6b2\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=2a2393390760ae85eb74ee3a539e1d758bfdd8815a1a6d6f14d4a2fbcfdcd5b7\nAccept: */*\n\n{\n \"JobFlowId\": \"j-3TS0OIYO4NFN\",\n \"Steps\": [{\n \"Name\": \"Example Jar Step\",\n \"ActionOnFailure\": \"CANCEL_AND_WAIT\",\n \"HadoopJarStep\": {\n \"Jar\": \"s3n:\\\\/\\\\/elasticmapreduce\\\\/samples\\\\/cloudburst\\\\/cloudburst.jar\",\n \"Args\": [\n \"s3n:\\\\/\\\\/elasticmapreduce\\\\/samples\\\\/cloudburst\\\\/input\\\\/s_suis.br\",\n \"s3n:\\\\/\\\\/elasticmapreduce\\\\/samples\\\\/cloudburst\\\\/input\\\\/100k.br\",\n \"s3n:\\\\/\\\\/examples-bucket\\\\/cloudburst\\\\/output\",\n \"36\",\n \"3\",\n \"0\",\n \"1\",\n \"240\",\n \"48\",\n \"24\",\n \"24\",\n \"128\",\n \"16\"\n ]\n }\n }]\n}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 6514261f-ee5b-11e2-9345-5332e9ab2e6d\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Tue, 16 Jul 2013 21:05:07 GMT\n\n \n " + }, + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddTagsInput", + "documentation":"

This input identifies a cluster and a list of tags to attach. \n

" + }, + "output":{ + "shape":"AddTagsOutput", + "documentation":"

This output indicates the result of adding tags to a resource. \n

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. \n For more information, see Tagging Amazon EMR Resources. \n

\n \n POST / HTTP/1.1 \nContent-Type: application/x-amz-json-1.1 \nX-Amz-Target: ElasticMapReduce.AddTags \nAUTHPARAMS \n{ \n \"ResourceId\": \"j-3U7TSX5GZFD8Y\", \n \"Tags\": [{ \n \"Key\": \"stack\", \n \"Value\": \"Production\" \n }, \n { \n \"Key\": \"hbase\" \n }] \n} \n\n\n HTTP/1.1 200 OK \nx-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8d \nContent-Type: application/x-amz-json-1.1 \nContent-Length: 71 \nDate: Mon, 15 Jul 2013 22:33:47 GMT \n{ \n} \n \n " + }, + "DescribeCluster":{ + "name":"DescribeCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeClusterInput", + "documentation":"

This input determines which cluster to describe.

" + }, + "output":{ + "shape":"DescribeClusterOutput", + "documentation":"

This output contains the description of the cluster.

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.

" + }, + "DescribeJobFlows":{ + "name":"DescribeJobFlows", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeJobFlowsInput", + "documentation":"

The input for the DescribeJobFlows operation.

" + }, + "output":{ + "shape":"DescribeJobFlowsOutput", + "documentation":"

The output for the DescribeJobFlows operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + } + ], + "deprecated":true, + "documentation":"

This API is deprecated and will eventually be removed. We recommend you use ListClusters,\n DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions\n instead.

\n

DescribeJobFlows returns a list of job flows that match all of the supplied parameters.\n The parameters can include a list of job flow IDs, job flow states, and restrictions on job\n flow creation date and time.

\n

Regardless of supplied parameters, only job flows created within the last two months are\n returned.

\n

If no parameters are supplied, then job flows matching either of the following criteria\n are returned:

\n \n

Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions.

\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.DescribeJobFlows\nContent-Length: 62\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130715T220330Z\nX-Amz-Content-Sha256: fce83af973f96f173512aca2845c56862b946feb1de0600326f1365b658a0e39\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=29F98a6f44e05ad54fe1e8b3d1a7101ab08dc3ad348995f89c533693cee2bb3b\nAccept: */*\n\n{\n \"JobFlowIds\": [\"j-ZKIY4CKQRX72\"],\n \"DescriptionType\": \"EXTENDED\"\n}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 634d4142-ed9a-11e2-bbba-b56d7d016ec4\nContent-Type: application/x-amz-json-1.1\nContent-Length: 1624\nDate: Mon, 15 Jul 2013 22:03:31 GMT\n\n{\"JobFlows\": [{\n \"AmiVersion\": \"2.3.6\",\n \"BootstrapActions\": [],\n \"ExecutionStatusDetail\": {\n \"CreationDateTime\": 1.373923429E9,\n \"EndDateTime\": 1.373923995E9,\n \"LastStateChangeReason\": \"Steps completed\",\n \"ReadyDateTime\": 1.373923754E9,\n \"StartDateTime\": 1.373923754E9,\n \"State\": \"COMPLETED\"\n },\n \"Instances\": {\n \"HadoopVersion\": \"1.0.3\",\n \"InstanceCount\": 1,\n \"InstanceGroups\": [{\n \"CreationDateTime\": 1.373923429E9,\n \"EndDateTime\": 1.373923995E9,\n \"InstanceGroupId\": \"ig-3SRUWV3E0NB7K\",\n \"InstanceRequestCount\": 1,\n \"InstanceRole\": \"MASTER\",\n \"InstanceRunningCount\": 0,\n \"InstanceType\": \"m1.small\",\n \"LastStateChangeReason\": \"Job flow terminated\",\n \"Market\": \"ON_DEMAND\",\n \"Name\": \"Master InstanceGroup\",\n \"ReadyDateTime\": 1.37392375E9,\n \"StartDateTime\": 1.373923646E9,\n \"State\": \"ENDED\"\n }],\n \"KeepJobFlowAliveWhenNoSteps\": false,\n \"MasterInstanceId\": \"i-8c4fbbef\",\n \"MasterInstanceType\": \"m1.small\",\n \"MasterPublicDnsName\": \"ec2-107-20-46-140.compute-1.amazonaws.com\",\n \"NormalizedInstanceHours\": 1,\n \"Placement\": {\"AvailabilityZone\": \"us-east-1a\"},\n \"TerminationProtected\": false\n },\n \"JobFlowId\": \"j-ZKIY4CKQRX72\",\n \"Name\": \"Development Job Flow\",\n \"Steps\": [{\n \"ExecutionStatusDetail\": {\n \"CreationDateTime\": 1.373923429E9,\n \"EndDateTime\": 1.373923914E9,\n \"StartDateTime\": 1.373923754E9,\n \"State\": \"COMPLETED\"\n },\n \"StepConfig\": {\n \"ActionOnFailure\": \"CANCEL_AND_WAIT\",\n \"HadoopJarStep\": {\n \"Args\": [\n \"-input\",\n \"s3://elasticmapreduce/samples/wordcount/input\",\n \"-output\",\n \"s3://examples-bucket/example-output\",\n \"-mapper\",\n \"s3://elasticmapreduce/samples/wordcount/wordSplitter.py\",\n \"-reducer\",\n \"aggregate\"\n ],\n \"Jar\": \"/home/hadoop/contrib/streaming/hadoop-streaming.jar\",\n \"Properties\": []\n },\n \"Name\": \"Example Streaming Step\"\n }\n }],\n \"SupportedProducts\": [],\n \"VisibleToAllUsers\": false\n}]}\n\n " + }, + "DescribeStep":{ + "name":"DescribeStep", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeStepInput", + "documentation":"

This input determines which step to describe.

" + }, + "output":{ + "shape":"DescribeStepOutput", + "documentation":"

This output contains the description of the cluster step.

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Provides more detail about the cluster step.

" + }, + "ListBootstrapActions":{ + "name":"ListBootstrapActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListBootstrapActionsInput", + "documentation":"

This input determines which bootstrap actions to retrieve.

" + }, + "output":{ + "shape":"ListBootstrapActionsOutput", + "documentation":"

This output contains the boostrap actions detail\n .

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Provides information about the bootstrap actions associated with a cluster.

" + }, + "ListClusters":{ + "name":"ListClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListClustersInput", + "documentation":"

This input determines how the ListClusters action filters the list of clusters that it returns.

" + }, + "output":{ + "shape":"ListClustersOutput", + "documentation":"

This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status.\n This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. \n

" + }, + "ListInstanceGroups":{ + "name":"ListInstanceGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListInstanceGroupsInput", + "documentation":"

This input determines which instance groups to retrieve.

" + }, + "output":{ + "shape":"ListInstanceGroupsOutput", + "documentation":"

This input determines which instance groups to retrieve.

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Provides all available details about the instance groups in a cluster.

" + }, + "ListInstances":{ + "name":"ListInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListInstancesInput", + "documentation":"

This input determines which instances to list.

" + }, + "output":{ + "shape":"ListInstancesOutput", + "documentation":"

This output contains the list of instances.

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. \n For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.\n

" + }, + "ListSteps":{ + "name":"ListSteps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListStepsInput", + "documentation":"

This input determines which steps to list.

" + }, + "output":{ + "shape":"ListStepsOutput", + "documentation":"

This output contains the list of steps.

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Provides a list of steps for the cluster. \n

" + }, + "ModifyInstanceGroups":{ + "name":"ModifyInstanceGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyInstanceGroupsInput", + "documentation":"

Change the size of some instance groups.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + } + ], + "documentation":"

ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance\n group. The input parameters include the new target instance count for the group and the\n instance group ID. The call will either succeed or fail atomically.

\n\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.ModifyInstanceGroups\nContent-Length: 77\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130716T205843Z\nX-Amz-Content-Sha256: bb1af3d0c6c6a1a09f21ccd7f04a0e2e6c9ce5b5810b0f6777560fe4f81bda8c\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=17bbbb4448a1f47a14d5657445e9de5cadf16bed58b850585f80865882133b33\nAccept: */*\n\n{\"InstanceGroups\": [{\n \"InstanceGroupId\": \"ig-1S8NWT31S2OVG\",\n \"InstanceCount\": 5\n}]}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 80a74808-ee5a-11e2-90db-69a5154aeb8d\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Tue, 16 Jul 2013 20:58:44 GMT\n\n \n " + }, + "RemoveTags":{ + "name":"RemoveTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTagsInput", + "documentation":"

This input identifies a cluster and a list of tags to remove. \n

" + }, + "output":{ + "shape":"RemoveTagsOutput", + "documentation":"

This output indicates the result of removing tags from a resource. \n

" + }, + "errors":[ + { + "shape":"InternalServerException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + } + ], + "documentation":"

Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. \n For more information, see Tagging Amazon EMR Resources. \n

\n

The following example removes the stack tag with value Prod from a cluster:

\n \n POST / HTTP/1.1 \nContent-Type: application/x-amz-json-1.1 \nX-Amz-Target: ElasticMapReduce.RemoveTags \nAUTHPARAMS \n{ \n \"ResourceId\": \"j-3U7TSX5GZFD8Y\", \n \"Tags\": [{ \n \"Key\": \"stack\", \n \"Value\": \"Prod\" \n }] \n} \n\n\n HTTP/1.1 200 OK \nx-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8d \nContent-Type: application/x-amz-json-1.1 \nContent-Length: 71 \nDate: Mon, 15 Jul 2013 22:33:47 GMT \n{ \n} \n \n

The following example removes the stack and hbase tags from a cluster:

\n POST / HTTP/1.1 \nContent-Type: application/x-amz-json-1.1 \nX-Amz-Target: ElasticMapReduce.RemoveTags \nAUTHPARAMS \n{ \n \"ResourceId\": \"j-3U7TSX5GZFD8Y\", \n \"Tags\": [{ \n \"Key\": \"stack\" \n }, \n { \n \"Key\": \"hbase\" \n }] \n} \n\n\n HTTP/1.1 200 OK \nx-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8d \nContent-Type: application/x-amz-json-1.1 \nContent-Length: 71 \nDate: Mon, 15 Jul 2013 22:33:47 GMT \n{ \n} \n \n " + }, + "RunJobFlow":{ + "name":"RunJobFlow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RunJobFlowInput", + "documentation":"

Input to the RunJobFlow operation.

" + }, + "output":{ + "shape":"RunJobFlowOutput", + "documentation":"

The result of the RunJobFlow operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + } + ], + "documentation":"

RunJobFlow creates and starts running a new job flow. The job flow will run the steps\n specified. Once the job flow completes, the cluster is stopped and the HDFS partition is\n lost. To prevent loss of data, configure the last step of the job flow to store results in\n Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is\n set to TRUE, the job flow will transition to the WAITING state rather than\n shutting down once the steps have completed.

\n \n

For additional protection, you can set the \n JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the \n job flow and prevent it from being \n terminated by API call, user intervention, or in the event of a job flow error.

\n\n

A maximum of 256 steps are allowed in each job flow.

\n \n

If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.

\n\n

For long running job flows, we recommend that you periodically store your results.

\n\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.RunJobFlow\nContent-Length: 734\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130715T210803Z\nX-Amz-Content-Sha256: 8676d21986e4628a89fb1232a1344063778d4ffc23d10be02b437e0d53a24db3\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=71f79725c4dbe77c0e842718485f0b37fe6df69e1153c80f7748ebd9617ca2f3\nAccept: */*\n\n\n{\n \"Name\": \"Development Job Flow\",\n \"Instances\": {\n \"KeepJobFlowAliveWhenNoSteps\": \"false\",\n \"TerminationProtected\": \"false\",\n \"InstanceGroups\": [{\n \"Name\": \"Master Instance Group\",\n \"InstanceRole\": \"MASTER\",\n \"InstanceCount\": 1,\n \"InstanceType\": \"m1.small\",\n \"Market\": \"ON_DEMAND\"\n }]\n },\n \"Steps\": [{\n \"Name\": \"Example Streaming Step\",\n \"ActionOnFailure\": \"CANCEL_AND_WAIT\",\n \"HadoopJarStep\": {\n \"Jar\": \"/home/hadoop/contrib/streaming/hadoop-streaming.jar\",\n \"Args\": [\n \"-input\",\n \"s3://elasticmapreduce/samples/wordcount/input\",\n \"-output\",\n \"s3://examples-bucket/example-output\",\n \"-mapper\",\n \"s3://elasticmapreduce/samples/wordcount/wordSplitter.py\",\n \"-reducer\",\n \"aggregate\"\n ]\n }\n }],\n \"BootstrapActions\": [],\n \"VisibleToAllUsers\": \"false\",\n \"NewSupportedProducts\": [],\n \"AmiVersion\": \"latest\"\n}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: a4406d6b-ed92-11e2-9787-192218ecb460\nContent-Type: application/x-amz-json-1.1\nContent-Length: 31\nDate: Mon, 15 Jul 2013 21:08:05 GMT\n\n{\"JobFlowId\": \"j-ZKIY4CKQRX72\"}\n \n " + }, + "SetTerminationProtection":{ + "name":"SetTerminationProtection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetTerminationProtectionInput", + "documentation":"

The input argument to the TerminationProtection operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + } + ], + "documentation":"

SetTerminationProtection locks a job flow so the Amazon EC2 instances in the cluster \n cannot be terminated by user intervention, an API call, or in the event of a job-flow error. \n The cluster still terminates upon successful completion of the job flow. Calling \n SetTerminationProtection on a job flow is analogous to calling the \n Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster.

\n \n

SetTerminationProtection is used to prevent accidental termination of a job flow and to \n ensure that in the event of an error, the instances will persist so you can recover \n any data stored in their ephemeral instance storage.

\n \n

To terminate a job flow that has been locked by setting SetTerminationProtection to true, \n you must first unlock the job flow by a subsequent call to SetTerminationProtection \n in which you set the value to false.

\n \n

For more information, go to Protecting a Job Flow from Termination in the \n Amazon Elastic MapReduce Developer's Guide.

\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.SetTerminationProtection\nContent-Length: 61\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130716T211420Z\nX-Amz-Content-Sha256: c362fadae0fce377aa63f04388aeb90c53cedb17a8bfbb8cffcb10c2378137f9\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=764b6aa1a38733cadff35a2e884887e9f1208a422266bc83ac77e8d0b80bd4cf\nAccept: */*\n\n{\n \"JobFlowIds\": [\"j-3TS0OIYO4NFN\"],\n \"TerminationProtected\": true\n}\n\n \n HTTP/1.1 200 OK\nx-amzn-RequestId: af23b1db-ee5c-11e2-9787-192218ecb460\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Tue, 16 Jul 2013 21:14:21 GMT\n\n \n " + }, + "SetVisibleToAllUsers":{ + "name":"SetVisibleToAllUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetVisibleToAllUsersInput", + "documentation":"

The input to the SetVisibleToAllUsers action.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + } + ], + "documentation":"

Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified job flows. This action works on running job flows. You can also set the visibility of \n a job flow when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the job flow or the AWS account that owns the job flow.

\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.SetVisibleToAllUsers\nContent-Length: 58\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130715T221616Z\nX-Amz-Content-Sha256: 2ff32d11eab2383d764ffcb97571454e798689ecd09a7b1bb2327e22b0b930d4\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=e1a00b37787d9ccc43c9de32f1f0a73813b0bd6643d4db7762b62a7092d51997\nAccept: */*\n\n{\n \"JobFlowIds\": [\"j-ZKIY4CKQRX72\"],\n \"VisibleToAllUsers\": true\n}\n\n\n \n HTTP/1.1 200 OK\nx-amzn-RequestId: 2be9cde9-ed9c-11e2-82b6-2351cde3f33f\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 15 Jul 2013 22:16:18 GMT\n\n\n \n " + }, + "TerminateJobFlows":{ + "name":"TerminateJobFlows", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"TerminateJobFlowsInput", + "documentation":"

Input to the TerminateJobFlows operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + } + ], + "documentation":"

\n TerminateJobFlows shuts a list of job flows down. When a job flow is shut down, any step\n not yet completed is canceled and the EC2 instances on which the job flow is running are\n stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was\n specified when the job flow was created. \n

\n

\n The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, \n it may take up to 5-20 minutes for the job flow to \n completely terminate and release allocated resources, such as Amazon EC2 instances.\n

\n \n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.TerminateJobFlows\nContent-Length: 33\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130716T211858Z\nX-Amz-Content-Sha256: ab64713f61e066e80a6083844b9249b6c6362d34a7ae7393047aa46d38b9e315\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=9791416eaf09f36aa753a324b0de27ff5cc7084b8548cc748487a2bcb3439d58\nAccept: */*\n\n{\"JobFlowIds\": [\"j-3TS0OIYO4NFN\"]}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 5551a7c9-ee5d-11e2-9542-25296c300ff0\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Tue, 16 Jul 2013 21:18:59 GMT\n \n " + } + }, + "shapes":{ + "ActionOnFailure":{ + "type":"string", + "enum":[ + "TERMINATE_JOB_FLOW", + "TERMINATE_CLUSTER", + "CANCEL_AND_WAIT", + "CONTINUE" + ] + }, + "AddInstanceGroupsInput":{ + "type":"structure", + "required":[ + "InstanceGroups", + "JobFlowId" + ], + "members":{ + "InstanceGroups":{ + "shape":"InstanceGroupConfigList", + "documentation":"

Instance Groups to add.

" + }, + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Job flow in which to add the instance groups.

" + } + }, + "documentation":"

Input to an AddInstanceGroups call.

" + }, + "AddInstanceGroupsOutput":{ + "type":"structure", + "members":{ + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The job flow ID in which the instance groups are added.

" + }, + "InstanceGroupIds":{ + "shape":"InstanceGroupIdsList", + "documentation":"

Instance group IDs of the newly created instance groups.

" + } + }, + "documentation":"

Output from an AddInstanceGroups call.

" + }, + "AddJobFlowStepsInput":{ + "type":"structure", + "required":[ + "JobFlowId", + "Steps" + ], + "members":{ + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

A string that uniquely identifies the job flow. This identifier is returned by\n RunJobFlow and can also be obtained from ListClusters.

" + }, + "Steps":{ + "shape":"StepConfigList", + "documentation":"

A list of StepConfig to be executed by the job flow.

" + } + }, + "documentation":"

The input argument to the AddJobFlowSteps operation.

" + }, + "AddJobFlowStepsOutput":{ + "type":"structure", + "members":{ + "StepIds":{ + "shape":"StepIdsList", + "documentation":"

The identifiers of the list of steps added to the job flow.

" + } + }, + "documentation":"

The output for the AddJobFlowSteps operation.

" + }, + "AddTagsInput":{ + "type":"structure", + "required":[ + "ResourceId", + "Tags" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags to associate with a cluster and propagate to Amazon EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.

" + } + }, + "documentation":"

This input identifies a cluster and a list of tags to attach. \n

" + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

This output indicates the result of adding tags to a resource. \n

" + }, + "Application":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the application.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version of the application.

" + }, + "Args":{ + "shape":"StringList", + "documentation":"

Arguments for Amazon EMR to pass to the application.

" + }, + "AdditionalInfo":{ + "shape":"StringMap", + "documentation":"

This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

" + } + }, + "documentation":"

An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation\n script as bootstrap action argument. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

\n " + }, + "ApplicationList":{ + "type":"list", + "member":{"shape":"Application"} + }, + "Boolean":{"type":"boolean"}, + "BootstrapActionConfig":{ + "type":"structure", + "required":[ + "Name", + "ScriptBootstrapAction" + ], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the bootstrap action.

" + }, + "ScriptBootstrapAction":{ + "shape":"ScriptBootstrapActionConfig", + "documentation":"

The script run by the bootstrap action.

" + } + }, + "documentation":"

Configuration of a bootstrap action.

" + }, + "BootstrapActionConfigList":{ + "type":"list", + "member":{"shape":"BootstrapActionConfig"} + }, + "BootstrapActionDetail":{ + "type":"structure", + "members":{ + "BootstrapActionConfig":{ + "shape":"BootstrapActionConfig", + "documentation":"

A description of the bootstrap action.

" + } + }, + "documentation":"

Reports the configuration of a bootstrap action in a job flow.

" + }, + "BootstrapActionDetailList":{ + "type":"list", + "member":{"shape":"BootstrapActionDetail"} + }, + "Cluster":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ClusterId", + "documentation":"

The unique identifier for the cluster.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the cluster.

" + }, + "Status":{ + "shape":"ClusterStatus", + "documentation":"

The current status details about the cluster.

" + }, + "Ec2InstanceAttributes":{"shape":"Ec2InstanceAttributes"}, + "LogUri":{ + "shape":"String", + "documentation":"

The path to the Amazon S3 location where logs for this cluster are stored.

" + }, + "RequestedAmiVersion":{ + "shape":"String", + "documentation":"

The AMI version requested for this cluster.

" + }, + "RunningAmiVersion":{ + "shape":"String", + "documentation":"

The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as \"latest\".

" + }, + "AutoTerminate":{ + "shape":"Boolean", + "documentation":"

Specifies whether the cluster should terminate after completing all steps.

" + }, + "TerminationProtected":{ + "shape":"Boolean", + "documentation":"

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or \n user intervention, or in the event of a cluster error.

" + }, + "VisibleToAllUsers":{ + "shape":"Boolean", + "documentation":"

Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. \n If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

" + }, + "Applications":{ + "shape":"ApplicationList", + "documentation":"

The applications installed on this cluster.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags associated with a cluster.

" + }, + "ServiceRole":{ + "shape":"String", + "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" + } + }, + "documentation":"

The detailed description of the cluster.

" + }, + "ClusterId":{"type":"string"}, + "ClusterState":{ + "type":"string", + "enum":[ + "STARTING", + "BOOTSTRAPPING", + "RUNNING", + "WAITING", + "TERMINATING", + "TERMINATED", + "TERMINATED_WITH_ERRORS" + ] + }, + "ClusterStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClusterStateChangeReasonCode", + "documentation":"

The programmatic code for the state change reason.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The descriptive message for the state change reason.

" + } + }, + "documentation":"

The reason that the cluster changed to its current state.

" + }, + "ClusterStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "VALIDATION_ERROR", + "INSTANCE_FAILURE", + "BOOTSTRAP_FAILURE", + "USER_REQUEST", + "STEP_FAILURE", + "ALL_STEPS_COMPLETED" + ] + }, + "ClusterStateList":{ + "type":"list", + "member":{"shape":"ClusterState"} + }, + "ClusterStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ClusterState", + "documentation":"

The current state of the cluster.

" + }, + "StateChangeReason":{ + "shape":"ClusterStateChangeReason", + "documentation":"

The reason for the cluster status change.

" + }, + "Timeline":{ + "shape":"ClusterTimeline", + "documentation":"

A timeline that represents the status of a cluster over the lifetime of the cluster.

" + } + }, + "documentation":"

The detailed status of the cluster.

" + }, + "ClusterSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ClusterId", + "documentation":"

The unique identifier for the cluster.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the cluster.

" + }, + "Status":{ + "shape":"ClusterStatus", + "documentation":"

The details about the current status of the cluster.

" + } + }, + "documentation":"

The summary description of the cluster.

" + }, + "ClusterSummaryList":{ + "type":"list", + "member":{"shape":"ClusterSummary"} + }, + "ClusterTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the cluster.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster was ready to execute steps.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster was terminated.

" + } + }, + "documentation":"

Represents the timeline of the cluster's lifecycle.

" + }, + "Command":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the command.

" + }, + "ScriptPath":{ + "shape":"String", + "documentation":"

The Amazon S3 location of the command script.

" + }, + "Args":{ + "shape":"StringList", + "documentation":"

Arguments for Amazon EMR to pass to the command for execution.

" + } + }, + "documentation":"

An entity describing an executable that runs on a cluster.

" + }, + "CommandList":{ + "type":"list", + "member":{"shape":"Command"} + }, + "Date":{"type":"timestamp"}, + "DescribeClusterInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster to describe.

" + } + }, + "documentation":"

This input determines which cluster to describe.

" + }, + "DescribeClusterOutput":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

This output contains the details for the requested cluster.

" + } + }, + "documentation":"

This output contains the description of the cluster.

" + }, + "DescribeJobFlowsInput":{ + "type":"structure", + "members":{ + "CreatedAfter":{ + "shape":"Date", + "documentation":"

Return only job flows created after this date and time.

" + }, + "CreatedBefore":{ + "shape":"Date", + "documentation":"

Return only job flows created before this date and time.

" + }, + "JobFlowIds":{ + "shape":"XmlStringList", + "documentation":"

Return only job flows whose job flow ID is contained in this list.

" + }, + "JobFlowStates":{ + "shape":"JobFlowExecutionStateList", + "documentation":"

Return only job flows whose state is contained in this list.

" + } + }, + "documentation":"

The input for the DescribeJobFlows operation.

" + }, + "DescribeJobFlowsOutput":{ + "type":"structure", + "members":{ + "JobFlows":{ + "shape":"JobFlowDetailList", + "documentation":"

A list of job flows matching the parameters supplied.

" + } + }, + "documentation":"

The output for the DescribeJobFlows operation.

" + }, + "DescribeStepInput":{ + "type":"structure", + "required":[ + "ClusterId", + "StepId" + ], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster with steps to describe.

" + }, + "StepId":{ + "shape":"StepId", + "documentation":"

The identifier of the step to describe.

" + } + }, + "documentation":"

This input determines which step to describe.

" + }, + "DescribeStepOutput":{ + "type":"structure", + "members":{ + "Step":{ + "shape":"Step", + "documentation":"

The step details for the requested step identifier.

" + } + }, + "documentation":"

This output contains the description of the cluster step.

" + }, + "EC2InstanceIdsToTerminateList":{ + "type":"list", + "member":{"shape":"InstanceId"} + }, + "Ec2InstanceAttributes":{ + "type":"structure", + "members":{ + "Ec2KeyName":{ + "shape":"String", + "documentation":"

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as\n a user named \"hadoop\".

" + }, + "Ec2SubnetId":{ + "shape":"String", + "documentation":"

\n To launch the job flow in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where \n you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal AWS cloud, outside of \n a VPC. \n

\n

\n Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. \n Thus, you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a VPC.\n

" + }, + "Ec2AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the cluster will run.

" + }, + "IamInstanceProfile":{ + "shape":"String", + "documentation":"

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

" + } + }, + "documentation":"

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

" + }, + "ErrorCode":{ + "type":"string", + "min":1, + "max":256 + }, + "ErrorMessage":{"type":"string"}, + "HadoopJarStepConfig":{ + "type":"structure", + "required":["Jar"], + "members":{ + "Properties":{ + "shape":"KeyValueList", + "documentation":"

A list of Java properties that are set when the step runs. You can use these properties to\n pass key value pairs to your main function.

" + }, + "Jar":{ + "shape":"XmlString", + "documentation":"

A path to a JAR file run during the step.

" + }, + "MainClass":{ + "shape":"XmlString", + "documentation":"

The name of the main class in the specified Java file. If not specified, the JAR file\n should specify a Main-Class in its manifest file.

" + }, + "Args":{ + "shape":"XmlStringList", + "documentation":"

A list of command line arguments passed to the JAR file's main function when executed.

" + } + }, + "documentation":"

A job flow step consisting of a JAR file whose main function will be executed. The main\n function submits a job for Hadoop to execute and waits for the job to finish or fail.

" + }, + "HadoopStepConfig":{ + "type":"structure", + "members":{ + "Jar":{ + "shape":"String", + "documentation":"

The path to the JAR file that runs during the step.

" + }, + "Properties":{ + "shape":"StringMap", + "documentation":"

The list of Java properties that are set when the step runs. You can use these properties to\n pass key value pairs to your main function.

" + }, + "MainClass":{ + "shape":"String", + "documentation":"

The name of the main class in the specified Java file. If not specified, the JAR file\n should specify a main class in its manifest file.

" + }, + "Args":{ + "shape":"StringList", + "documentation":"

The list of command line arguments to pass to the JAR file's main function for execution.

" + } + }, + "documentation":"

A cluster step consisting of a JAR file whose main function will be executed. The main\n function submits a job for Hadoop to execute and waits for the job to finish or fail.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"InstanceId", + "documentation":"

The unique identifier for the instance in Amazon EMR.

" + }, + "Ec2InstanceId":{ + "shape":"InstanceId", + "documentation":"

The unique identifier of the instance in Amazon EC2.

" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name of the instance.

" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address of the instance.

" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name of the instance.

" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the instance.

" + }, + "Status":{ + "shape":"InstanceStatus", + "documentation":"

The current status of the instance.

" + } + }, + "documentation":"

Represents an EC2 instance provisioned as part of cluster.

" + }, + "InstanceGroup":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"InstanceGroupId", + "documentation":"

The identifier of the instance group.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance group.

" + }, + "Market":{ + "shape":"MarketType", + "documentation":"

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

" + }, + "InstanceGroupType":{ + "shape":"InstanceGroupType", + "documentation":"

The type of the instance group. Valid values are MASTER, CORE or TASK.

" + }, + "BidPrice":{ + "shape":"String", + "documentation":"

The bid price for each EC2 instance in the\n instance group when launching nodes as Spot Instances, expressed in USD.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type for all instances in the instance group.

" + }, + "RequestedInstanceCount":{ + "shape":"Integer", + "documentation":"

The target number of instances for the instance group.

" + }, + "RunningInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances currently running in this instance group.

" + }, + "Status":{ + "shape":"InstanceGroupStatus", + "documentation":"

The current status of the instance group.

" + } + }, + "documentation":"

This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

" + }, + "InstanceGroupConfig":{ + "type":"structure", + "required":[ + "InstanceRole", + "InstanceType", + "InstanceCount" + ], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Friendly name given to the instance group.

" + }, + "Market":{ + "shape":"MarketType", + "documentation":"

Market type of the Amazon EC2 instances used to create a cluster node.

" + }, + "InstanceRole":{ + "shape":"InstanceRoleType", + "documentation":"

The role of the instance group in the cluster.

" + }, + "BidPrice":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Bid price for each Amazon EC2 instance in the\n instance group when launching nodes as Spot Instances, expressed in USD.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The Amazon EC2 instance type for all instances in the instance group.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

Target number of instances for the instance group.

" + } + }, + "documentation":"

Configuration defining a new instance group.

" + }, + "InstanceGroupConfigList":{ + "type":"list", + "member":{"shape":"InstanceGroupConfig"} + }, + "InstanceGroupDetail":{ + "type":"structure", + "required":[ + "Market", + "InstanceRole", + "InstanceType", + "InstanceRequestCount", + "InstanceRunningCount", + "State", + "CreationDateTime" + ], + "members":{ + "InstanceGroupId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Unique identifier for the instance group.

" + }, + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Friendly name for the instance group.

" + }, + "Market":{ + "shape":"MarketType", + "documentation":"

Market type of the Amazon EC2 instances used to create a cluster node.

" + }, + "InstanceRole":{ + "shape":"InstanceRoleType", + "documentation":"

Instance group role in the cluster

" + }, + "BidPrice":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Bid price for EC2 Instances when launching nodes as\n Spot Instances, expressed in USD.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

Amazon EC2 Instance type.

" + }, + "InstanceRequestCount":{ + "shape":"Integer", + "documentation":"

Target number of instances to run in the instance group.

" + }, + "InstanceRunningCount":{ + "shape":"Integer", + "documentation":"

Actual count of running instances.

" + }, + "State":{ + "shape":"InstanceGroupState", + "documentation":"

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

" + }, + "LastStateChangeReason":{ + "shape":"XmlString", + "documentation":"

Details regarding the state of the instance group.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date/time the instance group was created.

" + }, + "StartDateTime":{ + "shape":"Date", + "documentation":"

The date/time the instance group was started.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date/time the instance group was available to the cluster.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date/time the instance group was terminated.

" + } + }, + "documentation":"

Detailed information about an instance group.

" + }, + "InstanceGroupDetailList":{ + "type":"list", + "member":{"shape":"InstanceGroupDetail"} + }, + "InstanceGroupId":{"type":"string"}, + "InstanceGroupIdsList":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + }, + "InstanceGroupList":{ + "type":"list", + "member":{"shape":"InstanceGroup"} + }, + "InstanceGroupModifyConfig":{ + "type":"structure", + "required":["InstanceGroupId"], + "members":{ + "InstanceGroupId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Unique ID of the instance group to expand or shrink.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

Target size for the instance group.

" + }, + "EC2InstanceIdsToTerminate":{ + "shape":"EC2InstanceIdsToTerminateList", + "documentation":"

The EC2 InstanceIds to terminate. For advanced users only. \n Once you terminate the instances, the instance group will not return to its original requested size.

" + } + }, + "documentation":"

Modify an instance group size.

" + }, + "InstanceGroupModifyConfigList":{ + "type":"list", + "member":{"shape":"InstanceGroupModifyConfig"} + }, + "InstanceGroupState":{ + "type":"string", + "enum":[ + "PROVISIONING", + "BOOTSTRAPPING", + "RUNNING", + "RESIZING", + "SUSPENDED", + "TERMINATING", + "TERMINATED", + "ARRESTED", + "SHUTTING_DOWN", + "ENDED" + ] + }, + "InstanceGroupStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"InstanceGroupStateChangeReasonCode", + "documentation":"

The programmable code for the state change reason.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The status change reason description.

" + } + }, + "documentation":"

The status change reason details for the instance group.

" + }, + "InstanceGroupStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "VALIDATION_ERROR", + "INSTANCE_FAILURE", + "CLUSTER_TERMINATED" + ] + }, + "InstanceGroupStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"InstanceGroupState", + "documentation":"

The current state of the instance group.

" + }, + "StateChangeReason":{ + "shape":"InstanceGroupStateChangeReason", + "documentation":"

The status change reason details for the instance group.

" + }, + "Timeline":{ + "shape":"InstanceGroupTimeline", + "documentation":"

The timeline of the instance group status over time.

" + } + }, + "documentation":"

The details of the instance group status.

" + }, + "InstanceGroupTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the instance group.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the instance group became ready to perform tasks.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the instance group terminated.

" + } + }, + "documentation":"

The timeline of the instance group lifecycle.

" + }, + "InstanceGroupType":{ + "type":"string", + "enum":[ + "MASTER", + "CORE", + "TASK" + ] + }, + "InstanceGroupTypeList":{ + "type":"list", + "member":{"shape":"InstanceGroupType"} + }, + "InstanceId":{"type":"string"}, + "InstanceList":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstanceRoleType":{ + "type":"string", + "enum":[ + "MASTER", + "CORE", + "TASK" + ] + }, + "InstanceState":{ + "type":"string", + "enum":[ + "AWAITING_FULFILLMENT", + "PROVISIONING", + "BOOTSTRAPPING", + "RUNNING", + "TERMINATED" + ] + }, + "InstanceStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"InstanceStateChangeReasonCode", + "documentation":"

The programmable code for the state change reason.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The status change reason description.

" + } + }, + "documentation":"

The details of the status change reason for the instance.

" + }, + "InstanceStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "VALIDATION_ERROR", + "INSTANCE_FAILURE", + "BOOTSTRAP_FAILURE", + "CLUSTER_TERMINATED" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

" + }, + "StateChangeReason":{ + "shape":"InstanceStateChangeReason", + "documentation":"

The details of the status change reason for the instance.

" + }, + "Timeline":{ + "shape":"InstanceTimeline", + "documentation":"

The timeline of the instance status over time.

" + } + }, + "documentation":"

The instance status details.

" + }, + "InstanceTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the instance.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the instance was ready to perform tasks.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the instance was terminated.

" + } + }, + "documentation":"

The timeline of the instance lifecycle.

" + }, + "InstanceType":{ + "type":"string", + "min":1, + "max":256, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "Integer":{"type":"integer"}, + "InternalServerError":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InternalFailure", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not\n completed.

" + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"ErrorMessage", + "documentation":"

The message associated with the exception.

" + } + }, + "exception":true, + "fault":true, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

" + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code associated with the exception.

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

The message associated with the exception.

" + } + }, + "exception":true, + "documentation":"

This exception occurs when there is something wrong with user input.

" + }, + "JobFlowDetail":{ + "type":"structure", + "required":[ + "JobFlowId", + "Name", + "ExecutionStatusDetail", + "Instances" + ], + "members":{ + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The job flow identifier.

" + }, + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the job flow.

" + }, + "LogUri":{ + "shape":"XmlString", + "documentation":"

The location in Amazon S3 where log files for the job are stored.

" + }, + "AmiVersion":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently \n supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the \n Amazon Elastic MapReduce Developer's Guide.

" + }, + "ExecutionStatusDetail":{ + "shape":"JobFlowExecutionStatusDetail", + "documentation":"

Describes the execution status of the job flow.

" + }, + "Instances":{ + "shape":"JobFlowInstancesDetail", + "documentation":"

Describes the Amazon EC2 instances of the job flow.

" + }, + "Steps":{ + "shape":"StepDetailList", + "documentation":"

A list of steps run by the job flow.

" + }, + "BootstrapActions":{ + "shape":"BootstrapActionDetailList", + "documentation":"

A list of the bootstrap actions run by the job flow.

" + }, + "SupportedProducts":{ + "shape":"SupportedProductsList", + "documentation":"

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

" + }, + "VisibleToAllUsers":{ + "shape":"Boolean", + "documentation":"

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

" + }, + "JobFlowRole":{ + "shape":"XmlString", + "documentation":"

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

" + }, + "ServiceRole":{ + "shape":"XmlString", + "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" + } + }, + "documentation":"

A description of a job flow.

" + }, + "JobFlowDetailList":{ + "type":"list", + "member":{"shape":"JobFlowDetail"} + }, + "JobFlowExecutionState":{ + "type":"string", + "enum":[ + "STARTING", + "BOOTSTRAPPING", + "RUNNING", + "WAITING", + "SHUTTING_DOWN", + "TERMINATED", + "COMPLETED", + "FAILED" + ], + "documentation":"

The type of instance.

\n \n \n

A small instance

\n \n \n

A large instance

\n \n " + }, + "JobFlowExecutionStateList":{ + "type":"list", + "member":{"shape":"JobFlowExecutionState"} + }, + "JobFlowExecutionStatusDetail":{ + "type":"structure", + "required":[ + "State", + "CreationDateTime" + ], + "members":{ + "State":{ + "shape":"JobFlowExecutionState", + "documentation":"

The state of the job flow.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the job flow.

" + }, + "StartDateTime":{ + "shape":"Date", + "documentation":"

The start date and time of the job flow.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the job flow was ready to start running bootstrap actions.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The completion date and time of the job flow.

" + }, + "LastStateChangeReason":{ + "shape":"XmlString", + "documentation":"

Description of the job flow last changed state.

" + } + }, + "documentation":"

Describes the status of the job flow.

" + }, + "JobFlowInstancesConfig":{ + "type":"structure", + "members":{ + "MasterInstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type of the master node.

" + }, + "SlaveInstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type of the slave nodes.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Amazon EC2 instances used to execute the job flow.

" + }, + "InstanceGroups":{ + "shape":"InstanceGroupConfigList", + "documentation":"

Configuration for the job flow's instance groups.

" + }, + "Ec2KeyName":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the Amazon EC2 key pair that can be used to ssh to the master node as\n the user called \"hadoop.\"

" + }, + "Placement":{ + "shape":"PlacementType", + "documentation":"

The Availability Zone the job flow will run in.

" + }, + "KeepJobFlowAliveWhenNoSteps":{ + "shape":"Boolean", + "documentation":"

Specifies whether the job flow should terminate after completing all steps.

" + }, + "TerminationProtected":{ + "shape":"Boolean", + "documentation":"

Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, \n user intervention, or in the event of a job flow error.

" + }, + "HadoopVersion":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The Hadoop version for the job flow. Valid inputs are \"0.18\", \"0.20\", or \"0.20.205\". If you do not set this value, the default of 0.18 is used, \n unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

" + }, + "Ec2SubnetId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

\n To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where \n you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an \n Amazon VPC. \n

\n

\n Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. \n Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.\n

" + } + }, + "documentation":"

A description of the Amazon EC2 instance running the job flow. \n A valid JobFlowInstancesConfig must contain at least InstanceGroups, which is the recommended configuration. However, a valid alternative is to have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present).

" + }, + "JobFlowInstancesDetail":{ + "type":"structure", + "required":[ + "MasterInstanceType", + "SlaveInstanceType", + "InstanceCount" + ], + "members":{ + "MasterInstanceType":{ + "shape":"InstanceType", + "documentation":"

The Amazon EC2 master node instance type.

" + }, + "MasterPublicDnsName":{ + "shape":"XmlString", + "documentation":"

The DNS name of the master node.

" + }, + "MasterInstanceId":{ + "shape":"XmlString", + "documentation":"

The Amazon EC2 instance identifier of the master node.

" + }, + "SlaveInstanceType":{ + "shape":"InstanceType", + "documentation":"

The Amazon EC2 slave node instance type.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance\n serves as both the master and slave node. If the value is greater than 1, one instance is\n the master node and all others are slave nodes.

" + }, + "InstanceGroups":{ + "shape":"InstanceGroupDetailList", + "documentation":"

Details about the job flow's instance groups.

" + }, + "NormalizedInstanceHours":{ + "shape":"Integer", + "documentation":"

An approximation of the cost of the job flow, represented in m1.small/hours. This value is\n incremented once for every hour an m1.small runs. Larger instances are weighted more, so an\n Amazon EC2 instance that is roughly four times more expensive would result in the\n normalized instance hours being incremented by four. This result is only an approximation\n and does not reflect the actual billing rate.

" + }, + "Ec2KeyName":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of an Amazon EC2 key pair that can be used to ssh to the master node of job\n flow.

" + }, + "Ec2SubnetId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

" + }, + "Placement":{ + "shape":"PlacementType", + "documentation":"

The Amazon EC2 Availability Zone for the job flow.

" + }, + "KeepJobFlowAliveWhenNoSteps":{ + "shape":"Boolean", + "documentation":"

Specifies whether the job flow should terminate after completing all steps.

" + }, + "TerminationProtected":{ + "shape":"Boolean", + "documentation":"

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, \n user intervention, or in the event of a job flow error.

" + }, + "HadoopVersion":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The Hadoop version for the job flow.

" + } + }, + "documentation":"

Specify the type of Amazon EC2 instances to run the job flow on.

" + }, + "KeyValue":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"XmlString", + "documentation":"

The unique identifier of a key value pair.

" + }, + "Value":{ + "shape":"XmlString", + "documentation":"

The value part of the identified key.

" + } + }, + "documentation":"

A key value pair.

" + }, + "KeyValueList":{ + "type":"list", + "member":{"shape":"KeyValue"} + }, + "ListBootstrapActionsInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The cluster identifier for the bootstrap actions to list\n .

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve\n .

" + } + }, + "documentation":"

This input determines which bootstrap actions to retrieve.

" + }, + "ListBootstrapActionsOutput":{ + "type":"structure", + "members":{ + "BootstrapActions":{ + "shape":"CommandList", + "documentation":"

The bootstrap actions associated with the cluster\n .

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve\n .

" + } + }, + "documentation":"

This output contains the boostrap actions detail\n .

" + }, + "ListClustersInput":{ + "type":"structure", + "members":{ + "CreatedAfter":{ + "shape":"Date", + "documentation":"

The creation date and time beginning value filter for listing clusters\n .

" + }, + "CreatedBefore":{ + "shape":"Date", + "documentation":"

The creation date and time end value filter for listing clusters\n .

" + }, + "ClusterStates":{ + "shape":"ClusterStateList", + "documentation":"

The cluster state filters to apply when listing clusters.\n

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.\n

" + } + }, + "documentation":"

This input determines how the ListClusters action filters the list of clusters that it returns.

" + }, + "ListClustersOutput":{ + "type":"structure", + "members":{ + "Clusters":{ + "shape":"ClusterSummaryList", + "documentation":"

The list of clusters for the account based on the given filters.\n

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.\n

" + } + }, + "documentation":"

This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.

" + }, + "ListInstanceGroupsInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster for which to list the instance groups.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which instance groups to retrieve.

" + }, + "ListInstanceGroupsOutput":{ + "type":"structure", + "members":{ + "InstanceGroups":{ + "shape":"InstanceGroupList", + "documentation":"

The list of instance groups for the cluster and given filters.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which instance groups to retrieve.

" + }, + "ListInstancesInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster for which to list the instances.

" + }, + "InstanceGroupId":{ + "shape":"InstanceGroupId", + "documentation":"

The identifier of the instance group for which to list the instances.

" + }, + "InstanceGroupTypes":{ + "shape":"InstanceGroupTypeList", + "documentation":"

The type of instance group for which to list the instances.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which instances to list.

" + }, + "ListInstancesOutput":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"InstanceList", + "documentation":"

The list of instances for the cluster and given filters.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This output contains the list of instances.

" + }, + "ListStepsInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster for which to list the steps.

" + }, + "StepStates":{ + "shape":"StepStateList", + "documentation":"

The filter to limit the step list based on certain states.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which steps to list.

" + }, + "ListStepsOutput":{ + "type":"structure", + "members":{ + "Steps":{ + "shape":"StepSummaryList", + "documentation":"

The filtered list of steps for the cluster.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This output contains the list of steps.

" + }, + "Marker":{"type":"string"}, + "MarketType":{ + "type":"string", + "enum":[ + "ON_DEMAND", + "SPOT" + ] + }, + "ModifyInstanceGroupsInput":{ + "type":"structure", + "members":{ + "InstanceGroups":{ + "shape":"InstanceGroupModifyConfigList", + "documentation":"

Instance groups to change.

" + } + }, + "documentation":"

Change the size of some instance groups.

" + }, + "NewSupportedProductsList":{ + "type":"list", + "member":{"shape":"SupportedProductConfig"} + }, + "PlacementType":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "AvailabilityZone":{ + "shape":"XmlString", + "documentation":"

The Amazon EC2 Availability Zone for the job flow.

" + } + }, + "documentation":"

The Amazon EC2 location for the job flow.

" + }, + "RemoveTagsInput":{ + "type":"structure", + "required":[ + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.

" + }, + "TagKeys":{ + "shape":"StringList", + "documentation":"

A list of tag keys to remove from a resource.

" + } + }, + "documentation":"

This input identifies a cluster and a list of tags to remove. \n

" + }, + "RemoveTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

This output indicates the result of removing tags from a resource. \n

" + }, + "ResourceId":{"type":"string"}, + "RunJobFlowInput":{ + "type":"structure", + "required":[ + "Name", + "Instances" + ], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the job flow.

" + }, + "LogUri":{ + "shape":"XmlString", + "documentation":"

The location in Amazon S3 to write the log files of the job flow. If a value is\n not provided, logs are not created.

" + }, + "AdditionalInfo":{ + "shape":"XmlString", + "documentation":"

A JSON string for selecting additional features.

" + }, + "AmiVersion":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:

\n \n \n

If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the \n JobFlowInstancesConfig HadoopVersion parameter\n to modify the version of Hadoop from the defaults shown above.

\n

For details about the AMI versions currently \n supported by Amazon Elastic MapReduce, go to AMI Versions Supported in Elastic MapReduce in the \n Amazon Elastic MapReduce Developer's Guide.\n

" + }, + "Instances":{ + "shape":"JobFlowInstancesConfig", + "documentation":"

A specification of the number and type of Amazon EC2 instances on which to run the job\n flow.

" + }, + "Steps":{ + "shape":"StepConfigList", + "documentation":"

A list of steps to be executed by the job flow.

" + }, + "BootstrapActions":{ + "shape":"BootstrapActionConfigList", + "documentation":"

A list of bootstrap actions that will be run before Hadoop is started on the cluster\n nodes.

" + }, + "SupportedProducts":{ + "shape":"SupportedProductsList", + "documentation":"

A list of strings that indicates third-party software to use with the job flow. For more information, go to Use Third Party Applications with Amazon EMR. Currently supported values are:

\n " + }, + "NewSupportedProducts":{ + "shape":"NewSupportedProductsList", + "documentation":"

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation\n script as bootstrap action arguments. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

\n " + }, + "VisibleToAllUsers":{ + "shape":"Boolean", + "documentation":"

Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it.

" + }, + "JobFlowRole":{ + "shape":"XmlString", + "documentation":"

An IAM role for the job flow. The EC2 instances of the job flow assume this role. The default role is EMRJobflowDefault. In order to use the default role, you must have already created it using the CLI.

" + }, + "ServiceRole":{ + "shape":"XmlString", + "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

" + } + }, + "documentation":"

Input to the RunJobFlow operation.

" + }, + "RunJobFlowOutput":{ + "type":"structure", + "members":{ + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

An unique identifier for the job flow.

" + } + }, + "documentation":"

The result of the RunJobFlow operation.

" + }, + "ScriptBootstrapActionConfig":{ + "type":"structure", + "required":["Path"], + "members":{ + "Path":{ + "shape":"XmlString", + "documentation":"

Location of the script to run during a bootstrap action. Can be either a location in Amazon\n S3 or on a local file system.

" + }, + "Args":{ + "shape":"XmlStringList", + "documentation":"

A list of command line arguments to pass to the bootstrap action script.

" + } + }, + "documentation":"

Configuration of the script to run during a bootstrap action.

" + }, + "SetTerminationProtectionInput":{ + "type":"structure", + "required":[ + "JobFlowIds", + "TerminationProtected" + ], + "members":{ + "JobFlowIds":{ + "shape":"XmlStringList", + "documentation":"

A list of strings that uniquely identify the job flows to protect. This identifier is returned by\n RunJobFlow and can also be obtained from DescribeJobFlows .

" + }, + "TerminationProtected":{ + "shape":"Boolean", + "documentation":"

A Boolean that indicates whether to protect the job flow and \n prevent the Amazon EC2 instances in the cluster from shutting down due to \n API calls, user intervention, or job-flow error.

" + } + }, + "documentation":"

The input argument to the TerminationProtection operation.

" + }, + "SetVisibleToAllUsersInput":{ + "type":"structure", + "required":[ + "JobFlowIds", + "VisibleToAllUsers" + ], + "members":{ + "JobFlowIds":{ + "shape":"XmlStringList", + "documentation":"

Identifiers of the job flows to receive the new visibility setting.

" + }, + "VisibleToAllUsers":{ + "shape":"Boolean", + "documentation":"

Whether the specified job flows are visible to all IAM users of the AWS account associated with the job flow. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the job flows. If it is set to False, only the IAM user that created a job flow can view and manage it.

" + } + }, + "documentation":"

The input to the SetVisibleToAllUsers action.

" + }, + "Step":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"StepId", + "documentation":"

The identifier of the cluster step.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the cluster step.

" + }, + "Config":{ + "shape":"HadoopStepConfig", + "documentation":"

The Hadoop job configuration of the cluster step.\n

" + }, + "ActionOnFailure":{ + "shape":"ActionOnFailure", + "documentation":"

This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.\n

" + }, + "Status":{ + "shape":"StepStatus", + "documentation":"

The current execution status details of the cluster step.\n

" + } + }, + "documentation":"

This represents a step in a cluster.

" + }, + "StepConfig":{ + "type":"structure", + "required":[ + "Name", + "HadoopJarStep" + ], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the job flow step.

" + }, + "ActionOnFailure":{ + "shape":"ActionOnFailure", + "documentation":"

The action to take if the job flow step fails.

" + }, + "HadoopJarStep":{ + "shape":"HadoopJarStepConfig", + "documentation":"

The JAR file used for the job flow step.

" + } + }, + "documentation":"

Specification of a job flow step.

" + }, + "StepConfigList":{ + "type":"list", + "member":{"shape":"StepConfig"} + }, + "StepDetail":{ + "type":"structure", + "required":[ + "StepConfig", + "ExecutionStatusDetail" + ], + "members":{ + "StepConfig":{ + "shape":"StepConfig", + "documentation":"

The step configuration.

" + }, + "ExecutionStatusDetail":{ + "shape":"StepExecutionStatusDetail", + "documentation":"

The description of the step status.

" + } + }, + "documentation":"

Combines the execution state and configuration of a step.

" + }, + "StepDetailList":{ + "type":"list", + "member":{"shape":"StepDetail"} + }, + "StepExecutionState":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "CONTINUE", + "COMPLETED", + "CANCELLED", + "FAILED", + "INTERRUPTED" + ] + }, + "StepExecutionStatusDetail":{ + "type":"structure", + "required":[ + "State", + "CreationDateTime" + ], + "members":{ + "State":{ + "shape":"StepExecutionState", + "documentation":"

The state of the job flow step.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the step.

" + }, + "StartDateTime":{ + "shape":"Date", + "documentation":"

The start date and time of the step.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The completion date and time of the step.

" + }, + "LastStateChangeReason":{ + "shape":"XmlString", + "documentation":"

A description of the step's current state.

" + } + }, + "documentation":"

The execution state of a step.

" + }, + "StepId":{"type":"string"}, + "StepIdsList":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + }, + "StepState":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "COMPLETED", + "CANCELLED", + "FAILED", + "INTERRUPTED" + ] + }, + "StepStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"StepStateChangeReasonCode", + "documentation":"

The programmable code for the state change reason.\n

" + }, + "Message":{ + "shape":"String", + "documentation":"

The descriptive message for the state change reason.\n

" + } + }, + "documentation":"

The details of the step state change reason. \n

" + }, + "StepStateChangeReasonCode":{ + "type":"string", + "enum":["NONE"] + }, + "StepStateList":{ + "type":"list", + "member":{"shape":"StepState"} + }, + "StepStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"StepState", + "documentation":"

The execution state of the cluster step.\n

" + }, + "StateChangeReason":{ + "shape":"StepStateChangeReason", + "documentation":"

The reason for the step execution status change.\n

" + }, + "Timeline":{ + "shape":"StepTimeline", + "documentation":"

The timeline of the cluster step status over time.\n

" + } + }, + "documentation":"

The execution status details of the cluster step.\n

" + }, + "StepSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"StepId", + "documentation":"

The identifier of the cluster step.\n

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the cluster step.\n

" + }, + "Status":{ + "shape":"StepStatus", + "documentation":"

The current execution status details of the cluster step.\n

" + } + }, + "documentation":"

The summary of the cluster step.

" + }, + "StepSummaryList":{ + "type":"list", + "member":{"shape":"StepSummary"} + }, + "StepTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster step was created.\n

" + }, + "StartDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster step execution started.\n

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster step execution completed or failed.\n

" + } + }, + "documentation":"

The timeline of the cluster step lifecycle.\n

" + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "SupportedProductConfig":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the product configuration.

" + }, + "Args":{ + "shape":"XmlStringList", + "documentation":"

The list of user-supplied arguments.

" + } + }, + "documentation":"

The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.

" + }, + "SupportedProductsList":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

A user-defined key, which is the minimum required information for a valid tag. \n For more information, see Tagging Amazon EMR Resources. \n

" + }, + "Value":{ + "shape":"String", + "documentation":"

A user-defined value, which is optional in a tag. \n For more information, see Tagging Amazon EMR Resources. \n

" + } + }, + "documentation":"

A key/value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clu\\\nsters to track your Amazon EMR resource allocation costs. \n For more information, see Tagging Amazon EMR Resources. \n

" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TerminateJobFlowsInput":{ + "type":"structure", + "required":["JobFlowIds"], + "members":{ + "JobFlowIds":{ + "shape":"XmlStringList", + "documentation":"

A list of job flows to be shutdown.

" + } + }, + "documentation":"

Input to the TerminateJobFlows operation.

" + }, + "XmlString":{ + "type":"string", + "min":0, + "max":10280, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringList":{ + "type":"list", + "member":{"shape":"XmlString"} + }, + "XmlStringMaxLen256":{ + "type":"string", + "min":0, + "max":256, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + } + } +} diff --git a/apis/elasticmapreduce-2009-03-31.paginators.json b/apis/elasticmapreduce-2009-03-31.paginators.json new file mode 100644 index 0000000000..87f282d779 --- /dev/null +++ b/apis/elasticmapreduce-2009-03-31.paginators.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "DescribeJobFlows": { + "result_key": "JobFlows" + }, + "ListBootstrapActions": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "BootstrapActions" + }, + "ListClusters": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Clusters" + }, + "ListInstanceGroups": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "InstanceGroups" + }, + "ListInstances": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Instances" + }, + "ListSteps": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Steps" + } + } +} diff --git a/apis/elastictranscoder-2012-09-25.api.json b/apis/elastictranscoder-2012-09-25.api.json new file mode 100644 index 0000000000..5dd801eddb --- /dev/null +++ b/apis/elastictranscoder-2012-09-25.api.json @@ -0,0 +1,871 @@ +{ + "metadata": { + "apiVersion": "2012-09-25", + "endpointPrefix": "elastictranscoder", + "serviceFullName": "Amazon Elastic Transcoder", + "signatureVersion": "v4", + "protocol": "rest-json" + }, + "operations": { + "CancelJob": { + "http": { + "method": "DELETE", + "requestUri": "/2012-09-25/jobs/{Id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateJob": { + "http": { + "requestUri": "/2012-09-25/jobs", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "PipelineId", + "Input" + ], + "members": { + "PipelineId": {}, + "Input": { + "shape": "S5" + }, + "Output": { + "shape": "Sc" + }, + "Outputs": { + "type": "list", + "member": { + "shape": "Sc" + } + }, + "OutputKeyPrefix": {}, + "Playlists": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Format": {}, + "OutputKeys": { + "shape": "S1b" + } + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "Job": { + "shape": "S1d" + } + } + } + }, + "CreatePipeline": { + "http": { + "requestUri": "/2012-09-25/pipelines", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "Name", + "InputBucket", + "Role" + ], + "members": { + "Name": {}, + "InputBucket": {}, + "OutputBucket": {}, + "Role": {}, + "Notifications": { + "shape": "S1q" + }, + "ContentConfig": { + "shape": "S1s" + }, + "ThumbnailConfig": { + "shape": "S1s" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S21" + } + } + } + }, + "CreatePreset": { + "http": { + "requestUri": "/2012-09-25/presets", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "Name", + "Container" + ], + "members": { + "Name": {}, + "Description": {}, + "Container": {}, + "Video": { + "shape": "S25" + }, + "Audio": { + "shape": "S2l" + }, + "Thumbnails": { + "shape": "S2s" + } + } + }, + "output": { + "type": "structure", + "members": { + "Preset": { + "shape": "S2w" + }, + "Warning": {} + } + } + }, + "DeletePipeline": { + "http": { + "method": "DELETE", + "requestUri": "/2012-09-25/pipelines/{Id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeletePreset": { + "http": { + "method": "DELETE", + "requestUri": "/2012-09-25/presets/{Id}", + "responseCode": 202 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "ListJobsByPipeline": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/jobsByPipeline/{PipelineId}" + }, + "input": { + "type": "structure", + "required": [ + "PipelineId" + ], + "members": { + "PipelineId": { + "location": "uri", + "locationName": "PipelineId" + }, + "Ascending": { + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Jobs": { + "shape": "S35" + }, + "NextPageToken": {} + } + } + }, + "ListJobsByStatus": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/jobsByStatus/{Status}" + }, + "input": { + "type": "structure", + "required": [ + "Status" + ], + "members": { + "Status": { + "location": "uri", + "locationName": "Status" + }, + "Ascending": { + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Jobs": { + "shape": "S35" + }, + "NextPageToken": {} + } + } + }, + "ListPipelines": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/pipelines" + }, + "input": { + "type": "structure", + "members": { + "Ascending": { + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipelines": { + "type": "list", + "member": { + "shape": "S21" + } + }, + "NextPageToken": {} + } + } + }, + "ListPresets": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/presets" + }, + "input": { + "type": "structure", + "members": { + "Ascending": { + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Presets": { + "type": "list", + "member": { + "shape": "S2w" + } + }, + "NextPageToken": {} + } + } + }, + "ReadJob": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/jobs/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Job": { + "shape": "S1d" + } + } + } + }, + "ReadPipeline": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/pipelines/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S21" + } + } + } + }, + "ReadPreset": { + "http": { + "method": "GET", + "requestUri": "/2012-09-25/presets/{Id}" + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "type": "structure", + "members": { + "Preset": { + "shape": "S2w" + } + } + } + }, + "TestRole": { + "http": { + "requestUri": "/2012-09-25/roleTests", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Role", + "InputBucket", + "OutputBucket", + "Topics" + ], + "members": { + "Role": {}, + "InputBucket": {}, + "OutputBucket": {}, + "Topics": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "Success": {}, + "Messages": { + "type": "list", + "member": {} + } + } + } + }, + "UpdatePipeline": { + "http": { + "method": "PUT", + "requestUri": "/2012-09-25/pipelines/{Id}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Name": {}, + "InputBucket": {}, + "Role": {}, + "Notifications": { + "shape": "S1q" + }, + "ContentConfig": { + "shape": "S1s" + }, + "ThumbnailConfig": { + "shape": "S1s" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S21" + } + } + } + }, + "UpdatePipelineNotifications": { + "http": { + "requestUri": "/2012-09-25/pipelines/{Id}/notifications" + }, + "input": { + "type": "structure", + "required": [ + "Id", + "Notifications" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Notifications": { + "shape": "S1q" + } + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S21" + } + } + } + }, + "UpdatePipelineStatus": { + "http": { + "requestUri": "/2012-09-25/pipelines/{Id}/status" + }, + "input": { + "type": "structure", + "required": [ + "Id", + "Status" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + }, + "Status": {} + } + }, + "output": { + "type": "structure", + "members": { + "Pipeline": { + "shape": "S21" + } + } + } + } + }, + "shapes": { + "S5": { + "type": "structure", + "members": { + "Key": {}, + "FrameRate": {}, + "Resolution": {}, + "AspectRatio": {}, + "Interlaced": {}, + "Container": {} + } + }, + "Sc": { + "type": "structure", + "members": { + "Key": {}, + "ThumbnailPattern": {}, + "Rotate": {}, + "PresetId": {}, + "SegmentDuration": {}, + "Watermarks": { + "shape": "Sg" + }, + "AlbumArt": { + "shape": "Sk" + }, + "Composition": { + "shape": "Ss" + }, + "Captions": { + "shape": "Sw" + } + } + }, + "Sg": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PresetWatermarkId": {}, + "InputKey": {} + } + } + }, + "Sk": { + "type": "structure", + "members": { + "MergePolicy": {}, + "Artwork": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InputKey": {}, + "MaxWidth": {}, + "MaxHeight": {}, + "SizingPolicy": {}, + "PaddingPolicy": {}, + "AlbumArtFormat": {} + } + } + } + } + }, + "Ss": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TimeSpan": { + "type": "structure", + "members": { + "StartTime": {}, + "Duration": {} + } + } + } + } + }, + "Sw": { + "type": "structure", + "members": { + "MergePolicy": {}, + "CaptionSources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Language": {}, + "TimeOffset": {}, + "Label": {} + } + } + }, + "CaptionFormats": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Format": {}, + "Pattern": {} + } + } + } + } + }, + "S1b": { + "type": "list", + "member": {} + }, + "S1d": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "PipelineId": {}, + "Input": { + "shape": "S5" + }, + "Output": { + "shape": "S1f" + }, + "Outputs": { + "type": "list", + "member": { + "shape": "S1f" + } + }, + "OutputKeyPrefix": {}, + "Playlists": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Format": {}, + "OutputKeys": { + "shape": "S1b" + }, + "Status": {}, + "StatusDetail": {} + } + } + }, + "Status": {} + } + }, + "S1f": { + "type": "structure", + "members": { + "Id": {}, + "Key": {}, + "ThumbnailPattern": {}, + "Rotate": {}, + "PresetId": {}, + "SegmentDuration": {}, + "Status": {}, + "StatusDetail": {}, + "Duration": { + "type": "long" + }, + "Width": { + "type": "integer" + }, + "Height": { + "type": "integer" + }, + "Watermarks": { + "shape": "Sg" + }, + "AlbumArt": { + "shape": "Sk" + }, + "Composition": { + "shape": "Ss" + }, + "Captions": { + "shape": "Sw" + } + } + }, + "S1q": { + "type": "structure", + "members": { + "Progressing": {}, + "Completed": {}, + "Warning": {}, + "Error": {} + } + }, + "S1s": { + "type": "structure", + "members": { + "Bucket": {}, + "StorageClass": {}, + "Permissions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GranteeType": {}, + "Grantee": {}, + "Access": { + "type": "list", + "member": {} + } + } + } + } + } + }, + "S21": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "Status": {}, + "InputBucket": {}, + "OutputBucket": {}, + "Role": {}, + "Notifications": { + "shape": "S1q" + }, + "ContentConfig": { + "shape": "S1s" + }, + "ThumbnailConfig": { + "shape": "S1s" + } + } + }, + "S25": { + "type": "structure", + "members": { + "Codec": {}, + "CodecOptions": { + "type": "map", + "key": {}, + "value": {} + }, + "KeyframesMaxDist": {}, + "FixedGOP": {}, + "BitRate": {}, + "FrameRate": {}, + "MaxFrameRate": {}, + "Resolution": {}, + "AspectRatio": {}, + "MaxWidth": {}, + "MaxHeight": {}, + "DisplayAspectRatio": {}, + "SizingPolicy": {}, + "PaddingPolicy": {}, + "Watermarks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "MaxWidth": {}, + "MaxHeight": {}, + "SizingPolicy": {}, + "HorizontalAlign": {}, + "HorizontalOffset": {}, + "VerticalAlign": {}, + "VerticalOffset": {}, + "Opacity": {}, + "Target": {} + } + } + } + } + }, + "S2l": { + "type": "structure", + "members": { + "Codec": {}, + "SampleRate": {}, + "BitRate": {}, + "Channels": {}, + "CodecOptions": { + "type": "structure", + "members": { + "Profile": {} + } + } + } + }, + "S2s": { + "type": "structure", + "members": { + "Format": {}, + "Interval": {}, + "Resolution": {}, + "AspectRatio": {}, + "MaxWidth": {}, + "MaxHeight": {}, + "SizingPolicy": {}, + "PaddingPolicy": {} + } + }, + "S2w": { + "type": "structure", + "members": { + "Id": {}, + "Arn": {}, + "Name": {}, + "Description": {}, + "Container": {}, + "Audio": { + "shape": "S2l" + }, + "Video": { + "shape": "S25" + }, + "Thumbnails": { + "shape": "S2s" + }, + "Type": {} + } + }, + "S35": { + "type": "list", + "member": { + "shape": "S1d" + } + } + } +} \ No newline at end of file diff --git a/apis/elastictranscoder-2012-09-25.full.json b/apis/elastictranscoder-2012-09-25.full.json new file mode 100644 index 0000000000..38fa386c09 --- /dev/null +++ b/apis/elastictranscoder-2012-09-25.full.json @@ -0,0 +1,2477 @@ +{ + "metadata":{ + "apiVersion":"2012-09-25", + "endpointPrefix":"elastictranscoder", + "serviceFullName":"Amazon Elastic Transcoder", + "signatureVersion":"v4", + "protocol":"rest-json" + }, + "documentation":"AWS Elastic Transcoder Service

The AWS Elastic Transcoder Service.

", + "operations":{ + "CancelJob":{ + "name":"CancelJob", + "http":{ + "method":"DELETE", + "requestUri":"/2012-09-25/jobs/{Id}", + "responseCode":202 + }, + "input":{ + "shape":"CancelJobRequest", + "documentation":"

The CancelJobRequest structure.

" + }, + "output":{ + "shape":"CancelJobResponse", + "documentation":"

The response body contains a JSON object. If the job is successfully canceled, the value of Success is true.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"ResourceInUseException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The CancelJob operation cancels an unfinished job.

" + }, + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/jobs", + "responseCode":201 + }, + "input":{ + "shape":"CreateJobRequest", + "documentation":"

The CreateJobRequest structure.

" + }, + "output":{ + "shape":"CreateJobResponse", + "documentation":"

The CreateJobResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"

Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

" + }, + "CreatePipeline":{ + "name":"CreatePipeline", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/pipelines", + "responseCode":201 + }, + "input":{ + "shape":"CreatePipelineRequest", + "documentation":"

The CreatePipelineRequest structure.

" + }, + "output":{ + "shape":"CreatePipelineResponse", + "documentation":"

When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"

Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The CreatePipeline operation creates a pipeline with settings that you specify.

" + }, + "CreatePreset":{ + "name":"CreatePreset", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/presets", + "responseCode":201 + }, + "input":{ + "shape":"CreatePresetRequest", + "documentation":"

The CreatePresetRequest structure.

" + }, + "output":{ + "shape":"CreatePresetResponse", + "documentation":"

The CreatePresetResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"

Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The CreatePreset operation creates a preset with settings that you specify.

Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

" + }, + "DeletePipeline":{ + "name":"DeletePipeline", + "http":{ + "method":"DELETE", + "requestUri":"/2012-09-25/pipelines/{Id}", + "responseCode":202 + }, + "input":{ + "shape":"DeletePipelineRequest", + "documentation":"

The DeletePipelineRequest structure.

" + }, + "output":{ + "shape":"DeletePipelineResponse", + "documentation":"

The DeletePipelineResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"ResourceInUseException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The DeletePipeline operation removes a pipeline.

You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error.

" + }, + "DeletePreset":{ + "name":"DeletePreset", + "http":{ + "method":"DELETE", + "requestUri":"/2012-09-25/presets/{Id}", + "responseCode":202 + }, + "input":{ + "shape":"DeletePresetRequest", + "documentation":"

The DeletePresetRequest structure.

" + }, + "output":{ + "shape":"DeletePresetResponse", + "documentation":"

The DeletePresetResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The DeletePreset operation removes a preset that you've added in an AWS region.

" + }, + "ListJobsByPipeline":{ + "name":"ListJobsByPipeline", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/jobsByPipeline/{PipelineId}" + }, + "input":{ + "shape":"ListJobsByPipelineRequest", + "documentation":"

The ListJobsByPipelineRequest structure.

" + }, + "output":{ + "shape":"ListJobsByPipelineResponse", + "documentation":"

The ListJobsByPipelineResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.

" + }, + "ListJobsByStatus":{ + "name":"ListJobsByStatus", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/jobsByStatus/{Status}" + }, + "input":{ + "shape":"ListJobsByStatusRequest", + "documentation":"

The ListJobsByStatusRequest structure.

" + }, + "output":{ + "shape":"ListJobsByStatusResponse", + "documentation":"

The ListJobsByStatusResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

" + }, + "ListPipelines":{ + "name":"ListPipelines", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/pipelines" + }, + "input":{ + "shape":"ListPipelinesRequest", + "documentation":"

The ListPipelineRequest structure.

" + }, + "output":{ + "shape":"ListPipelinesResponse", + "documentation":"

A list of the pipelines associated with the current AWS account.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

" + }, + "ListPresets":{ + "name":"ListPresets", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/presets" + }, + "input":{ + "shape":"ListPresetsRequest", + "documentation":"

The ListPresetsRequest structure.

" + }, + "output":{ + "shape":"ListPresetsResponse", + "documentation":"

The ListPresetsResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.

" + }, + "ReadJob":{ + "name":"ReadJob", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/jobs/{Id}" + }, + "input":{ + "shape":"ReadJobRequest", + "documentation":"

The ReadJobRequest structure.

" + }, + "output":{ + "shape":"ReadJobResponse", + "documentation":"

The ReadJobResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The ReadJob operation returns detailed information about a job.

" + }, + "ReadPipeline":{ + "name":"ReadPipeline", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/pipelines/{Id}" + }, + "input":{ + "shape":"ReadPipelineRequest", + "documentation":"

The ReadPipelineRequest structure.

" + }, + "output":{ + "shape":"ReadPipelineResponse", + "documentation":"

The ReadPipelineResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The ReadPipeline operation gets detailed information about a pipeline.

" + }, + "ReadPreset":{ + "name":"ReadPreset", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/presets/{Id}" + }, + "input":{ + "shape":"ReadPresetRequest", + "documentation":"

The ReadPresetRequest structure.

" + }, + "output":{ + "shape":"ReadPresetResponse", + "documentation":"

The ReadPresetResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The ReadPreset operation gets detailed information about a preset.

" + }, + "TestRole":{ + "name":"TestRole", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/roleTests", + "responseCode":200 + }, + "input":{ + "shape":"TestRoleRequest", + "documentation":"

The TestRoleRequest structure.

" + }, + "output":{ + "shape":"TestRoleResponse", + "documentation":"

The TestRoleResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The TestRole operation tests the IAM role used to create the pipeline.

The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.

" + }, + "UpdatePipeline":{ + "name":"UpdatePipeline", + "http":{ + "method":"PUT", + "requestUri":"/2012-09-25/pipelines/{Id}", + "responseCode":200 + }, + "input":{ + "shape":"UpdatePipelineRequest", + "documentation":"

The UpdatePipelineRequest structure.

" + }, + "output":{ + "shape":"UpdatePipelineResponse", + "documentation":"

When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"ResourceInUseException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

" + }, + "UpdatePipelineNotifications":{ + "name":"UpdatePipelineNotifications", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/pipelines/{Id}/notifications" + }, + "input":{ + "shape":"UpdatePipelineNotificationsRequest", + "documentation":"

The UpdatePipelineNotificationsRequest structure.

" + }, + "output":{ + "shape":"UpdatePipelineNotificationsResponse", + "documentation":"

The UpdatePipelineNotificationsResponse structure.

" + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"ResourceInUseException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "UpdatePipelineStatus":{ + "name":"UpdatePipelineStatus", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/pipelines/{Id}/status" + }, + "input":{ + "shape":"UpdatePipelineStatusRequest", + "documentation":"

The UpdatePipelineStatusRequest structure.

" + }, + "output":{ + "shape":"UpdatePipelineStatusResponse", + "documentation":"When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request." + }, + "errors":[ + { + "shape":"ValidationException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + { + "shape":"IncompatibleVersionException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + { + "shape":"ResourceInUseException", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.

" + }, + { + "shape":"AccessDeniedException", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + } + ], + "documentation":"

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

" + } + }, + "shapes":{ + "AccessControl":{ + "type":"string", + "pattern":"(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)" + }, + "AccessControls":{ + "type":"list", + "member":{"shape":"AccessControl"}, + "max":30 + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"

General authentication failure. The request was not signed correctly.

" + }, + "Artwork":{ + "type":"structure", + "members":{ + "InputKey":{ + "shape":"WatermarkKey", + "documentation":"

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" + }, + "MaxWidth":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.

" + }, + "MaxHeight":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.

" + }, + "SizingPolicy":{ + "shape":"SizingPolicy", + "documentation":"

Specify one of the following values to control scaling of the output album art:

" + }, + "PaddingPolicy":{ + "shape":"PaddingPolicy", + "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight.

" + }, + "AlbumArtFormat":{ + "shape":"JpgOrPng", + "documentation":"

The format of album art, if any. Valid formats are .jpg and .png.

" + } + }, + "documentation":"

The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.

To remove artwork or leave the artwork empty, you can either set Artwork to null, or set the Merge Policy to \"Replace\" and use an empty Artwork array.

To pass through existing artwork unchanged, set the Merge Policy to \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

" + }, + "Artworks":{ + "type":"list", + "member":{"shape":"Artwork"} + }, + "Ascending":{ + "type":"string", + "pattern":"(^true$)|(^false$)" + }, + "AspectRatio":{ + "type":"string", + "pattern":"(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)" + }, + "AudioBitRate":{ + "type":"string", + "pattern":"^\\d{1,3}$" + }, + "AudioChannels":{ + "type":"string", + "pattern":"(^auto$)|(^0$)|(^1$)|(^2$)" + }, + "AudioCodec":{ + "type":"string", + "pattern":"(^AAC$)|(^vorbis$)|(^mp3$)" + }, + "AudioCodecOptions":{ + "type":"structure", + "members":{ + "Profile":{ + "shape":"AudioCodecProfile", + "documentation":"

You can only choose an audio profile when you specify AAC for the value of Audio:Codec.

Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:

All outputs in a Smooth playlist must have the same value for Profile.

" + } + }, + "documentation":"

Options associated with your audio codec.

" + }, + "AudioCodecProfile":{ + "type":"string", + "pattern":"(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)" + }, + "AudioParameters":{ + "type":"structure", + "members":{ + "Codec":{ + "shape":"AudioCodec", + "documentation":"

The audio codec for the output file. Valid values include aac, mp3, and vorbis.

" + }, + "SampleRate":{ + "shape":"AudioSampleRate", + "documentation":"

The sample rate of the audio stream in the output file, in Hertz. Valid values include:

auto, 22050, 32000, 44100, 48000, 96000

If you specify auto, Elastic Transcoder automatically detects the sample rate.

" + }, + "BitRate":{ + "shape":"AudioBitRate", + "documentation":"

The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.

" + }, + "Channels":{ + "shape":"AudioChannels", + "documentation":"

The number of audio channels in the output file. Valid values include:

auto, 0, 1, 2

If you specify auto, Elastic Transcoder automatically detects the number of channels in the input file.

" + }, + "CodecOptions":{ + "shape":"AudioCodecOptions", + "documentation":"

If you specified AAC for Audio:Codec, this is the AAC compression profile to use. Valid values include:

auto, AAC-LC, HE-AAC, HE-AACv2

If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

" + } + }, + "documentation":"

Parameters required for transcoding audio.

" + }, + "AudioSampleRate":{ + "type":"string", + "pattern":"(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)" + }, + "BucketName":{ + "type":"string", + "pattern":"^(\\w|\\.|-){1,255}$" + }, + "CancelJobRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

" + } + }, + "documentation":"

The CancelJobRequest structure.

" + }, + "CancelJobResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response body contains a JSON object. If the job is successfully canceled, the value of Success is true.

" + }, + "CaptionFormat":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"CaptionFormatFormat", + "documentation":"

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

" + }, + "Pattern":{ + "shape":"CaptionFormatPattern", + "documentation":"

The prefix for caption filenames, in the form description-{language}, where:

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends \"{language}\" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter \"Sydney-{language}-sunrise\", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.

" + } + }, + "documentation":"

The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.

" + }, + "CaptionFormatFormat":{ + "type":"string", + "pattern":"(^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)" + }, + "CaptionFormatPattern":{ + "type":"string", + "pattern":"(^$)|(^.*\\{language\\}.*$)" + }, + "CaptionFormats":{ + "type":"list", + "member":{"shape":"CaptionFormat"}, + "max":4 + }, + "CaptionMergePolicy":{ + "type":"string", + "pattern":"(^MergeOverride$)|(^MergeRetain$)|(^Override$)" + }, + "CaptionSource":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

" + }, + "Language":{ + "shape":"Key", + "documentation":"

A string that specifies the language of the caption. Specify this as one of:

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

" + }, + "TimeOffset":{ + "shape":"TimeOffset", + "documentation":"

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

" + }, + "Label":{ + "shape":"Name", + "documentation":"

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

" + } + }, + "documentation":"

A source file for the input sidecar captions used during the transcoding process.

" + }, + "CaptionSources":{ + "type":"list", + "member":{"shape":"CaptionSource"}, + "max":20 + }, + "Captions":{ + "type":"structure", + "members":{ + "MergePolicy":{ + "shape":"CaptionMergePolicy", + "documentation":"

A policy that determines how Elastic Transcoder handles the existence of multiple captions.

MergePolicy cannot be null.

" + }, + "CaptionSources":{ + "shape":"CaptionSources", + "documentation":"

Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

" + }, + "CaptionFormats":{ + "shape":"CaptionFormats", + "documentation":"

The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

" + } + }, + "documentation":"

The captions to be created, if any.

" + }, + "Clip":{ + "type":"structure", + "members":{ + "TimeSpan":{ + "shape":"TimeSpan", + "documentation":"

Settings that determine when a clip begins and how long it lasts.

" + } + }, + "documentation":"

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

" + }, + "CodecOption":{ + "type":"string", + "min":1, + "max":255 + }, + "CodecOptions":{ + "type":"map", + "key":{"shape":"CodecOption"}, + "value":{"shape":"CodecOption"}, + "max":30 + }, + "Composition":{ + "type":"list", + "member":{"shape":"Clip"} + }, + "CreateJobOutput":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.

" + }, + "ThumbnailPattern":{ + "shape":"ThumbnailPattern", + "documentation":"

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

" + }, + "Rotate":{ + "shape":"Rotate", + "documentation":"

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.

" + }, + "PresetId":{ + "shape":"Id", + "documentation":"

The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.

" + }, + "SegmentDuration":{ + "shape":"Float", + "documentation":"

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the duration of each segment in seconds. For ts containers, each media segment is stored in a separate .ts file. For fmp4 containers, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.

The range of valid values is 1 to 60 seconds.

" + }, + "Watermarks":{ + "shape":"JobWatermarks", + "documentation":"

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.

" + }, + "AlbumArt":{ + "shape":"JobAlbumArt", + "documentation":"

Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.

" + }, + "Composition":{ + "shape":"Composition", + "documentation":"

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

" + }, + "Captions":{ + "shape":"Captions", + "documentation":"

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" + } + }, + "documentation":"

The CreateJobOutput structure.

" + }, + "CreateJobOutputs":{ + "type":"list", + "member":{"shape":"CreateJobOutput"}, + "max":30 + }, + "CreateJobPlaylist":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Filename", + "documentation":"

The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. The name cannot include a / character. If you create more than one master playlist, the values of all Name objects must be unique. Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 playlists, .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.

" + }, + "Format":{ + "shape":"PlaylistFormat", + "documentation":"

The format of the output playlist. Valid formats include HLSv3 and Smooth.

" + }, + "OutputKeys":{ + "shape":"OutputKeys", + "documentation":"

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object. If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

" + } + }, + "documentation":"

Information about the master playlist.

" + }, + "CreateJobPlaylists":{ + "type":"list", + "member":{"shape":"CreateJobPlaylist"}, + "max":30 + }, + "CreateJobRequest":{ + "type":"structure", + "required":[ + "PipelineId", + "Input" + ], + "members":{ + "PipelineId":{ + "shape":"Id", + "documentation":"

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

" + }, + "Input":{ + "shape":"JobInput", + "documentation":"

A section of the request body that provides information about the file that is being transcoded.

" + }, + "Output":{"shape":"CreateJobOutput"}, + "Outputs":{ + "shape":"CreateJobOutputs", + "documentation":"

A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.

" + }, + "OutputKeyPrefix":{ + "shape":"Key", + "documentation":"

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.

" + }, + "Playlists":{ + "shape":"CreateJobPlaylists", + "documentation":"

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

The maximum number of master playlists in a job is 30.

" + } + }, + "documentation":"

The CreateJobRequest structure.

" + }, + "CreateJobResponse":{ + "type":"structure", + "members":{ + "Job":{ + "shape":"Job", + "documentation":"

A section of the response body that provides information about the job that is created.

" + } + }, + "documentation":"

The CreateJobResponse structure.

" + }, + "CreatePipelineRequest":{ + "type":"structure", + "required":[ + "Name", + "InputBucket", + "Role" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters.

" + }, + "InputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you saved the media files that you want to transcode.

" + }, + "OutputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

Specify this value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

" + }, + "Notifications":{ + "shape":"Notifications", + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. " + }, + "ContentConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

" + }, + "ThumbnailConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

" + } + }, + "documentation":"

The CreatePipelineRequest structure.

" + }, + "CreatePipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

A section of the response body that provides information about the pipeline that is created.

" + } + }, + "documentation":"

When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "CreatePresetRequest":{ + "type":"structure", + "required":[ + "Name", + "Container" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the preset.

" + }, + "Container":{ + "shape":"PresetContainer", + "documentation":"

The container type for the output file. Valid values include fmp4, mp3, mp4, ogg, ts, and webm.

" + }, + "Video":{ + "shape":"VideoParameters", + "documentation":"

A section of the request body that specifies the video parameters.

" + }, + "Audio":{ + "shape":"AudioParameters", + "documentation":"

A section of the request body that specifies the audio parameters.

" + }, + "Thumbnails":{ + "shape":"Thumbnails", + "documentation":"

A section of the request body that specifies the thumbnail parameters, if any.

" + } + }, + "documentation":"

The CreatePresetRequest structure.

" + }, + "CreatePresetResponse":{ + "type":"structure", + "members":{ + "Preset":{ + "shape":"Preset", + "documentation":"

A section of the response body that provides information about the preset that is created.

" + }, + "Warning":{ + "shape":"String", + "documentation":"

If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output.

" + } + }, + "documentation":"

The CreatePresetResponse structure.

" + }, + "DeletePipelineRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The identifier of the pipeline that you want to delete.

" + } + }, + "documentation":"

The DeletePipelineRequest structure.

" + }, + "DeletePipelineResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DeletePipelineResponse structure.

" + }, + "DeletePresetRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The identifier of the preset for which you want to get detailed information.

" + } + }, + "documentation":"

The DeletePresetRequest structure.

" + }, + "DeletePresetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DeletePresetResponse structure.

" + }, + "Description":{ + "type":"string", + "min":0, + "max":255 + }, + "Digits":{ + "type":"string", + "pattern":"^\\d{1,5}$" + }, + "DigitsOrAuto":{ + "type":"string", + "pattern":"(^auto$)|(^\\d{2,4}$)" + }, + "ExceptionMessages":{ + "type":"list", + "member":{"shape":"String"} + }, + "Filename":{ + "type":"string", + "min":1, + "max":255 + }, + "FixedGOP":{ + "type":"string", + "pattern":"(^true$)|(^false$)" + }, + "Float":{ + "type":"string", + "pattern":"^\\d{1,5}(\\.\\d{0,5})?$" + }, + "FrameRate":{ + "type":"string", + "pattern":"(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)" + }, + "Grantee":{ + "type":"string", + "min":1, + "max":255 + }, + "GranteeType":{ + "type":"string", + "pattern":"(^Canonical$)|(^Email$)|(^Group$)" + }, + "HorizontalAlign":{ + "type":"string", + "pattern":"(^Left$)|(^Right$)|(^Center$)" + }, + "Id":{ + "type":"string", + "pattern":"^\\d{13}-\\w{6}$" + }, + "IncompatibleVersionException":{ + "type":"structure", + "members":{ + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Interlaced":{ + "type":"string", + "pattern":"(^auto$)|(^true$)|(^false$)" + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "fault":true, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

" + }, + "Job":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the job.

" + }, + "PipelineId":{ + "shape":"Id", + "documentation":"

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

" + }, + "Input":{ + "shape":"JobInput", + "documentation":"

A section of the request or response body that provides information about the file that is being transcoded.

" + }, + "Output":{ + "shape":"JobOutput", + "documentation":"

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.

" + }, + "Outputs":{ + "shape":"JobOutputs", + "documentation":"

Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.

If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.

" + }, + "OutputKeyPrefix":{ + "shape":"Key", + "documentation":"

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.

" + }, + "Playlists":{ + "shape":"Playlists", + "documentation":"

Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

The maximum number of master playlists in a job is 30.

" + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

The status of the job: Submitted, Progressing, Complete, Canceled, or Error.

" + } + }, + "documentation":"

A section of the response body that provides information about the job that is created.

" + }, + "JobAlbumArt":{ + "type":"structure", + "members":{ + "MergePolicy":{ + "shape":"MergePolicy", + "documentation":"

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

" + }, + "Artwork":{ + "shape":"Artworks", + "documentation":"

The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are .jpg and .png

" + } + }, + "documentation":"

The .jpg or .png file associated with an audio file.

" + }, + "JobContainer":{ + "type":"string", + "pattern":"(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)" + }, + "JobInput":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" + }, + "FrameRate":{ + "shape":"FrameRate", + "documentation":"

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

" + }, + "Resolution":{ + "shape":"Resolution", + "documentation":"

This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

" + }, + "AspectRatio":{ + "shape":"AspectRatio", + "documentation":"

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

1:1, 4:3, 3:2, 16:9

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

" + }, + "Interlaced":{ + "shape":"Interlaced", + "documentation":"

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:

true, false

If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

" + }, + "Container":{ + "shape":"JobContainer", + "documentation":"

The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

" + } + }, + "documentation":"

Information about the file that you're transcoding.

" + }, + "JobOutput":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"

A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.

" + }, + "Key":{ + "shape":"Key", + "documentation":"

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID.

" + }, + "ThumbnailPattern":{ + "shape":"ThumbnailPattern", + "documentation":"

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

" + }, + "Rotate":{ + "shape":"Rotate", + "documentation":"

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:

auto, 0, 90, 180, 270

The value auto generally works only if the file that you're transcoding contains rotation metadata.

" + }, + "PresetId":{ + "shape":"Id", + "documentation":"

The value of the Id object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with ListPresets.

" + }, + "SegmentDuration":{ + "shape":"Float", + "documentation":"

(Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset in PresetId for which the value of Containeris fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.

The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.

Elastic Transcoder creates an output-specific playlist for each output HLSv3 output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in OutputKeys.

" + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output:

The value of Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error.

" + }, + "StatusDetail":{ + "shape":"Description", + "documentation":"

Information that further explains Status.

" + }, + "Duration":{ + "shape":"NullableLong", + "documentation":"

Duration of the output file, in seconds.

" + }, + "Width":{ + "shape":"NullableInteger", + "documentation":"

Specifies the width of the output file in pixels.

" + }, + "Height":{ + "shape":"NullableInteger", + "documentation":"

Height of the output file, in pixels.

" + }, + "Watermarks":{ + "shape":"JobWatermarks", + "documentation":"

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in Preset for the current output.

Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.

" + }, + "AlbumArt":{ + "shape":"JobAlbumArt", + "documentation":"

The album art to be associated with the output file, if any.

" + }, + "Composition":{ + "shape":"Composition", + "documentation":"

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

" + }, + "Captions":{ + "shape":"Captions", + "documentation":"

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" + } + }, + "documentation":"

Outputs recommended instead.If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

" + }, + "JobOutputs":{ + "type":"list", + "member":{"shape":"JobOutput"} + }, + "JobStatus":{ + "type":"string", + "pattern":"(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)" + }, + "JobWatermark":{ + "type":"structure", + "members":{ + "PresetWatermarkId":{ + "shape":"PresetWatermarkId", + "documentation":"

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

" + }, + "InputKey":{ + "shape":"WatermarkKey", + "documentation":"

The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" + } + }, + "documentation":"

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

" + }, + "JobWatermarks":{ + "type":"list", + "member":{"shape":"JobWatermark"} + }, + "Jobs":{ + "type":"list", + "member":{"shape":"Job"} + }, + "JpgOrPng":{ + "type":"string", + "pattern":"(^jpg$)|(^png$)" + }, + "Key":{ + "type":"string", + "min":1, + "max":255 + }, + "KeyframesMaxDist":{ + "type":"string", + "pattern":"^\\d{1,6}$" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "error":{"httpStatusCode":429}, + "exception":true, + "documentation":"

Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.

" + }, + "ListJobsByPipelineRequest":{ + "type":"structure", + "required":["PipelineId"], + "members":{ + "PipelineId":{ + "shape":"Id", + "location":"uri", + "locationName":"PipelineId", + "documentation":"

The ID of the pipeline for which you want to get job information.

" + }, + "Ascending":{ + "shape":"Ascending", + "location":"querystring", + "locationName":"Ascending", + "documentation":"

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

" + }, + "PageToken":{ + "shape":"Id", + "location":"querystring", + "locationName":"PageToken", + "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

" + } + }, + "documentation":"

The ListJobsByPipelineRequest structure.

" + }, + "ListJobsByPipelineResponse":{ + "type":"structure", + "members":{ + "Jobs":{ + "shape":"Jobs", + "documentation":"

An array of Job objects that are in the specified pipeline.

" + }, + "NextPageToken":{ + "shape":"Id", + "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" + } + }, + "documentation":"

The ListJobsByPipelineResponse structure.

" + }, + "ListJobsByStatusRequest":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"JobStatus", + "location":"uri", + "locationName":"Status", + "documentation":"

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

" + }, + "Ascending":{ + "shape":"Ascending", + "location":"querystring", + "locationName":"Ascending", + "documentation":"

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

" + }, + "PageToken":{ + "shape":"Id", + "location":"querystring", + "locationName":"PageToken", + "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

" + } + }, + "documentation":"

The ListJobsByStatusRequest structure.

" + }, + "ListJobsByStatusResponse":{ + "type":"structure", + "members":{ + "Jobs":{ + "shape":"Jobs", + "documentation":"

An array of Job objects that have the specified status.

" + }, + "NextPageToken":{ + "shape":"Id", + "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" + } + }, + "documentation":"

The ListJobsByStatusResponse structure.

" + }, + "ListPipelinesRequest":{ + "type":"structure", + "members":{ + "Ascending":{ + "shape":"Ascending", + "location":"querystring", + "locationName":"Ascending", + "documentation":"

To list pipelines in chronological order by the date and time that they were created, enter true. To list pipelines in reverse chronological order, enter false.

" + }, + "PageToken":{ + "shape":"Id", + "location":"querystring", + "locationName":"PageToken", + "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

" + } + }, + "documentation":"

The ListPipelineRequest structure.

" + }, + "ListPipelinesResponse":{ + "type":"structure", + "members":{ + "Pipelines":{ + "shape":"Pipelines", + "documentation":"

An array of Pipeline objects.

" + }, + "NextPageToken":{ + "shape":"Id", + "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" + } + }, + "documentation":"

A list of the pipelines associated with the current AWS account.

" + }, + "ListPresetsRequest":{ + "type":"structure", + "members":{ + "Ascending":{ + "shape":"Ascending", + "location":"querystring", + "locationName":"Ascending", + "documentation":"

To list presets in chronological order by the date and time that they were created, enter true. To list presets in reverse chronological order, enter false.

" + }, + "PageToken":{ + "shape":"Id", + "location":"querystring", + "locationName":"PageToken", + "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

" + } + }, + "documentation":"

The ListPresetsRequest structure.

" + }, + "ListPresetsResponse":{ + "type":"structure", + "members":{ + "Presets":{ + "shape":"Presets", + "documentation":"

An array of Preset objects.

" + }, + "NextPageToken":{ + "shape":"Id", + "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" + } + }, + "documentation":"

The ListPresetsResponse structure.

" + }, + "MaxFrameRate":{ + "type":"string", + "pattern":"(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)" + }, + "MergePolicy":{ + "type":"string", + "pattern":"(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)" + }, + "Name":{ + "type":"string", + "min":1, + "max":40 + }, + "Notifications":{ + "type":"structure", + "members":{ + "Progressing":{ + "shape":"SnsTopic", + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

" + }, + "Completed":{ + "shape":"SnsTopic", + "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

" + }, + "Warning":{ + "shape":"SnsTopic", + "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

" + }, + "Error":{ + "shape":"SnsTopic", + "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

" + } + }, + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console." + }, + "NullableInteger":{"type":"integer"}, + "NullableLong":{"type":"long"}, + "Opacity":{ + "type":"string", + "pattern":"^\\d{1,3}(\\.\\d{0,20})?$" + }, + "OutputKeys":{ + "type":"list", + "member":{"shape":"Key"}, + "max":30 + }, + "PaddingPolicy":{ + "type":"string", + "pattern":"(^Pad$)|(^NoPad$)" + }, + "Permission":{ + "type":"structure", + "members":{ + "GranteeType":{ + "shape":"GranteeType", + "documentation":"

The type of value that appears in the Grantee object:

" + }, + "Grantee":{ + "shape":"Grantee", + "documentation":"

The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

" + }, + "Access":{ + "shape":"AccessControls", + "documentation":"

The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

" + } + }, + "documentation":"

The Permission structure.

" + }, + "Permissions":{ + "type":"list", + "member":{"shape":"Permission"}, + "max":30 + }, + "Pipeline":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the pipeline.

" + }, + "Name":{ + "shape":"Name", + "documentation":"

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

" + }, + "Status":{ + "shape":"PipelineStatus", + "documentation":"

The current status of the pipeline:

" + }, + "InputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

" + }, + "OutputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

" + }, + "Notifications":{ + "shape":"Notifications", + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. " + }, + "ContentConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

" + }, + "ThumbnailConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

" + } + }, + "documentation":"

The pipeline (queue) that is used to manage jobs.

" + }, + "PipelineOutputConfig":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" + }, + "Permissions":{ + "shape":"Permissions", + "documentation":"

Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.

" + } + }, + "documentation":"

The PipelineOutputConfig structure.

" + }, + "PipelineStatus":{ + "type":"string", + "pattern":"(^Active$)|(^Paused$)" + }, + "Pipelines":{ + "type":"list", + "member":{"shape":"Pipeline"} + }, + "PixelsOrPercent":{ + "type":"string", + "pattern":"(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)" + }, + "Playlist":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Filename", + "documentation":"

The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. The name cannot include a / character. If you create more than one master playlist, the values of all Name objects must be unique. Note: Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 playlists, .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.

" + }, + "Format":{ + "shape":"PlaylistFormat", + "documentation":"

The format of the output playlist. Valid formats include HLSv3 and Smooth.

" + }, + "OutputKeys":{ + "shape":"OutputKeys", + "documentation":"

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object. If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

" + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

The status of the job with which the playlist is associated.

" + }, + "StatusDetail":{ + "shape":"Description", + "documentation":"

Information that further explains the status.

" + } + }, + "documentation":"

Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which the value of Container is fmp4 (Fragmented MP4> or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. We recommend that you create only one master playlist per output format. The maximum number of master playlists in a job is 30.

" + }, + "PlaylistFormat":{ + "type":"string", + "pattern":"(^HLSv3$)|(^Smooth$)" + }, + "Playlists":{ + "type":"list", + "member":{"shape":"Playlist"} + }, + "Preset":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

Identifier for the new preset. You use this value to get settings for the preset or to delete it.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the preset.

" + }, + "Name":{ + "shape":"Name", + "documentation":"

The name of the preset.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the preset.

" + }, + "Container":{ + "shape":"PresetContainer", + "documentation":"

The container type for the output file. Valid values include fmp4, mp3, mp4, ogg, ts, and webm.

" + }, + "Audio":{ + "shape":"AudioParameters", + "documentation":"

A section of the response body that provides information about the audio preset values.

" + }, + "Video":{ + "shape":"VideoParameters", + "documentation":"

A section of the response body that provides information about the video preset values.

" + }, + "Thumbnails":{ + "shape":"Thumbnails", + "documentation":"

A section of the response body that provides information about the thumbnail preset values, if any.

" + }, + "Type":{ + "shape":"PresetType", + "documentation":"

Whether the preset is a default preset provided by Elastic Transcoder (System) or a preset that you have defined (Custom).

" + } + }, + "documentation":"

Presets are templates that contain most of the settings for transcoding media files from one format to another. Elastic Transcoder includes some default presets for common formats, for example, several iPod and iPhone versions. You can also create your own presets for formats that aren't included among the default presets. You specify which preset you want to use when you create a job.

" + }, + "PresetContainer":{ + "type":"string", + "pattern":"(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)|(^fmp4$)" + }, + "PresetType":{ + "type":"string", + "pattern":"(^System$)|(^Custom$)" + }, + "PresetWatermark":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"PresetWatermarkId", + "documentation":"A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long." + }, + "MaxWidth":{ + "shape":"PixelsOrPercent", + "documentation":"

The maximum width of the watermark in one of the following formats:

" + }, + "MaxHeight":{ + "shape":"PixelsOrPercent", + "documentation":"

The maximum height of the watermark in one of the following formats:

If you specify the value in pixels, it must be less than or equal to the value of MaxHeight.

" + }, + "SizingPolicy":{ + "shape":"WatermarkSizingPolicy", + "documentation":"

A value that controls scaling of the watermark:

" + }, + "HorizontalAlign":{ + "shape":"HorizontalAlign", + "documentation":"

The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset:

" + }, + "HorizontalOffset":{ + "shape":"PixelsOrPercent", + "documentation":"

The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign:

For example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video.

HorizontalOffset is only valid when the value of HorizontalAlign is Left or Right. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

" + }, + "VerticalAlign":{ + "shape":"VerticalAlign", + "documentation":"

The vertical position of the watermark unless you specify a non-zero value for VerticalOffset:

" + }, + "VerticalOffset":{ + "shape":"PixelsOrPercent", + "documentation":"VerticalOffset

The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:

For example, if you specify Top for VerticalAlign and 5px for VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video.

VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom.

If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

" + }, + "Opacity":{ + "shape":"Opacity", + "documentation":"

A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of Opacity is float.

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't support transparency.

" + }, + "Target":{ + "shape":"Target", + "documentation":"

A value that determines how Elastic Transcoder interprets values that you specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:

" + } + }, + "documentation":"

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.

" + }, + "PresetWatermarkId":{ + "type":"string", + "min":1, + "max":40 + }, + "PresetWatermarks":{ + "type":"list", + "member":{"shape":"PresetWatermark"} + }, + "Presets":{ + "type":"list", + "member":{"shape":"Preset"} + }, + "ReadJobRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The identifier of the job for which you want to get detailed information.

" + } + }, + "documentation":"

The ReadJobRequest structure.

" + }, + "ReadJobResponse":{ + "type":"structure", + "members":{ + "Job":{ + "shape":"Job", + "documentation":"

A section of the response body that provides information about the job.

" + } + }, + "documentation":"

The ReadJobResponse structure.

" + }, + "ReadPipelineRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The identifier of the pipeline to read.

" + } + }, + "documentation":"

The ReadPipelineRequest structure.

" + }, + "ReadPipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

A section of the response body that provides information about the pipeline.

" + } + }, + "documentation":"

The ReadPipelineResponse structure.

" + }, + "ReadPresetRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The identifier of the preset for which you want to get detailed information.

" + } + }, + "documentation":"

The ReadPresetRequest structure.

" + }, + "ReadPresetResponse":{ + "type":"structure", + "members":{ + "Preset":{ + "shape":"Preset", + "documentation":"

A section of the response body that provides information about the preset.

" + } + }, + "documentation":"

The ReadPresetResponse structure.

" + }, + "Resolution":{ + "type":"string", + "pattern":"(^auto$)|(^\\d{1,5}x\\d{1,5}$)" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

" + }, + "Role":{ + "type":"string", + "pattern":"^arn:aws:iam::\\w{12}:role/.+$" + }, + "Rotate":{ + "type":"string", + "pattern":"(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)" + }, + "SizingPolicy":{ + "type":"string", + "pattern":"(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)" + }, + "SnsTopic":{ + "type":"string", + "pattern":"(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)" + }, + "SnsTopics":{ + "type":"list", + "member":{"shape":"SnsTopic"}, + "max":30 + }, + "StorageClass":{ + "type":"string", + "pattern":"(^ReducedRedundancy$)|(^Standard$)" + }, + "String":{"type":"string"}, + "Success":{ + "type":"string", + "pattern":"(^true$)|(^false$)" + }, + "Target":{ + "type":"string", + "pattern":"(^Content$)|(^Frame$)" + }, + "TestRoleRequest":{ + "type":"structure", + "required":[ + "Role", + "InputBucket", + "OutputBucket", + "Topics" + ], + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

" + }, + "InputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.

" + }, + "OutputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.

" + }, + "Topics":{ + "shape":"SnsTopics", + "documentation":"

The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

" + } + }, + "documentation":"

The TestRoleRequest structure.

" + }, + "TestRoleResponse":{ + "type":"structure", + "members":{ + "Success":{ + "shape":"Success", + "documentation":"

If the operation is successful, this value is true; otherwise, the value is false.

" + }, + "Messages":{ + "shape":"ExceptionMessages", + "documentation":"

If the Success element contains false, this value is an array of one or more error messages that were generated during the test process.

" + } + }, + "documentation":"

The TestRoleResponse structure.

" + }, + "ThumbnailPattern":{ + "type":"string", + "pattern":"(^$)|(^.*\\{count\\}.*$)" + }, + "ThumbnailResolution":{ + "type":"string", + "pattern":"^\\d{1,5}x\\d{1,5}$" + }, + "Thumbnails":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"JpgOrPng", + "documentation":"

The format of thumbnails, if any. Valid values are jpg and png.

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

" + }, + "Interval":{ + "shape":"Digits", + "documentation":"

The number of seconds between thumbnails. Specify an integer value.

" + }, + "Resolution":{ + "shape":"ThumbnailResolution", + "documentation":"

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.

" + }, + "AspectRatio":{ + "shape":"AspectRatio", + "documentation":"

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The aspect ratio of thumbnails. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.

" + }, + "MaxWidth":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.

" + }, + "MaxHeight":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.

" + }, + "SizingPolicy":{ + "shape":"SizingPolicy", + "documentation":"

Specify one of the following values to control scaling of thumbnails:

" + }, + "PaddingPolicy":{ + "shape":"PaddingPolicy", + "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.

" + } + }, + "documentation":"

Thumbnails for videos.

" + }, + "Time":{ + "type":"string", + "pattern":"(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)" + }, + "TimeOffset":{ + "type":"string", + "pattern":"(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)" + }, + "TimeSpan":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"Time", + "documentation":"

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

" + }, + "Duration":{ + "shape":"Time", + "documentation":"

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file.

If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.

" + } + }, + "documentation":"

Settings that determine when a clip begins and how long it lasts.

" + }, + "UpdatePipelineNotificationsRequest":{ + "type":"structure", + "required":[ + "Id", + "Notifications" + ], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The identifier of the pipeline for which you want to change notification settings.

" + }, + "Notifications":{ + "shape":"Notifications", + "documentation":"

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console. " + } + }, + "documentation":"

The UpdatePipelineNotificationsRequest structure.

" + }, + "UpdatePipelineNotificationsResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

A section of the response body that provides information about the pipeline.

" + } + }, + "documentation":"

The UpdatePipelineNotificationsResponse structure.

" + }, + "UpdatePipelineRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The ID of the pipeline that you want to update.

" + }, + "Name":{ + "shape":"Name", + "documentation":"

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

" + }, + "InputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.

" + }, + "Notifications":{"shape":"Notifications"}, + "ContentConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

" + }, + "ThumbnailConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

" + } + }, + "documentation":"

The UpdatePipelineRequest structure.

" + }, + "UpdatePipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{"shape":"Pipeline"} + }, + "documentation":"

When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "UpdatePipelineStatusRequest":{ + "type":"structure", + "required":[ + "Id", + "Status" + ], + "members":{ + "Id":{ + "shape":"Id", + "location":"uri", + "locationName":"Id", + "documentation":"

The identifier of the pipeline to update.

" + }, + "Status":{ + "shape":"PipelineStatus", + "documentation":"

The desired status of the pipeline:

" + } + }, + "documentation":"

The UpdatePipelineStatusRequest structure.

" + }, + "UpdatePipelineStatusResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

A section of the response body that provides information about the pipeline.

" + } + }, + "documentation":"When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request." + }, + "ValidationException":{ + "type":"structure", + "members":{ + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One or more required parameter values were not provided in the request.

" + }, + "VerticalAlign":{ + "type":"string", + "pattern":"(^Top$)|(^Bottom$)|(^Center$)" + }, + "VideoBitRate":{ + "type":"string", + "pattern":"(^\\d{2,5}$)|(^auto$)" + }, + "VideoCodec":{ + "type":"string", + "pattern":"(^H\\.264$)|(^vp8$)" + }, + "VideoParameters":{ + "type":"structure", + "members":{ + "Codec":{ + "shape":"VideoCodec", + "documentation":"

The video codec for the output file. Valid values include H.264 and vp8. You can only specify vp8 when the container type is webm.

" + }, + "CodecOptions":{ + "shape":"CodecOptions", + "documentation":"

Profile

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:

Level (H.264 Only)

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:

1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1

MaxReferenceFrames (H.264 Only)

Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:

Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)

where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the Level object. See the list below. (A macroblock is a block of pixels measuring 16x16.)

MaxBitRate

The maximum number of bits per second in a video buffer; the size of the buffer is specified by BufferSize. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video.

BufferSize

The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify MaxBitRate and omit BufferSize, Elastic Transcoder sets BufferSize to 10 times the value of MaxBitRate.

" + }, + "KeyframesMaxDist":{ + "shape":"KeyframesMaxDist", + "documentation":"

The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.

For Smooth outputs, the FrameRate must have a constant ratio to the KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels while the file is being played.

For example, an input file can have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist of 90, 75, and 30, respectively.

Alternately, this can be achieved by setting FrameRate to auto and having the same values for MaxFrameRate and KeyframesMaxDist.

" + }, + "FixedGOP":{ + "shape":"FixedGOP", + "documentation":"

Whether to use a fixed value for FixedGOP. Valid values are true and false:

FixedGOP must be set to true for fmp4 containers.

" + }, + "BitRate":{ + "shape":"VideoBitRate", + "documentation":"

The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of Level and Profile. If you specify auto, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than auto, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:

Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)

" + }, + "FrameRate":{ + "shape":"FrameRate", + "documentation":"

The frames per second for the video stream in the output file. Valid values include:

auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:

Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)

where:

The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):

" + }, + "MaxFrameRate":{ + "shape":"MaxFrameRate", + "documentation":"

If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60.

" + }, + "Resolution":{ + "shape":"Resolution", + "documentation":"

To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of the video in the output file, in pixels. Valid values are auto and width x height:

Note the following about specifying the width and height:

" + }, + "AspectRatio":{ + "shape":"AspectRatio", + "documentation":"

To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The display aspect ratio of the video in the output file. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file.

If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.

" + }, + "MaxWidth":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096.

" + }, + "MaxHeight":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.

" + }, + "DisplayAspectRatio":{ + "shape":"AspectRatio", + "documentation":"

The value that Elastic Transcoder adds to the metadata in the output file.

" + }, + "SizingPolicy":{ + "shape":"SizingPolicy", + "documentation":"

Specify one of the following values to control scaling of the output video:

" + }, + "PaddingPolicy":{ + "shape":"PaddingPolicy", + "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for MaxWidth and MaxHeight.

" + }, + "Watermarks":{ + "shape":"PresetWatermarks", + "documentation":"

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.

" + } + }, + "documentation":"

The VideoParameters structure.

" + }, + "WatermarkKey":{ + "type":"string", + "min":1, + "max":255, + "pattern":"(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)" + }, + "WatermarkSizingPolicy":{ + "type":"string", + "pattern":"(^Fit$)|(^Stretch$)|(^ShrinkToFit$)" + } + } +} diff --git a/apis/elastictranscoder-2012-09-25.paginators.json b/apis/elastictranscoder-2012-09-25.paginators.json new file mode 100644 index 0000000000..5a145d3688 --- /dev/null +++ b/apis/elastictranscoder-2012-09-25.paginators.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "ListJobsByPipeline": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Jobs" + }, + "ListJobsByStatus": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Jobs" + }, + "ListPipelines": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Pipelines" + }, + "ListPresets": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Presets" + } + } +} diff --git a/apis/elastictranscoder-2012-09-25.waiters.json b/apis/elastictranscoder-2012-09-25.waiters.json new file mode 100644 index 0000000000..109d16067d --- /dev/null +++ b/apis/elastictranscoder-2012-09-25.waiters.json @@ -0,0 +1,16 @@ +{ + "waiters": { + "JobComplete": { + "operation": "ReadJob", + "success_type": "output", + "success_path": "Job.Status", + "interval": 30, + "max_attempts": 120, + "success_value": "Complete", + "failure_value": [ + "Canceled", + "Error" + ] + } + } +} diff --git a/apis/email-2010-12-01.api.json b/apis/email-2010-12-01.api.json new file mode 100644 index 0000000000..d62e1913ae --- /dev/null +++ b/apis/email-2010-12-01.api.json @@ -0,0 +1,499 @@ +{ + "metadata": { + "apiVersion": "2010-12-01", + "endpointPrefix": "email", + "serviceAbbreviation": "Amazon SES", + "serviceFullName": "Amazon Simple Email Service", + "signatureVersion": "v4", + "signingName": "ses", + "xmlNamespace": "http://ses.amazonaws.com/doc/2010-12-01/", + "protocol": "query" + }, + "operations": { + "DeleteIdentity": { + "input": { + "type": "structure", + "required": [ + "Identity" + ], + "members": { + "Identity": {} + } + }, + "output": { + "resultWrapper": "DeleteIdentityResult", + "type": "structure", + "members": {} + } + }, + "DeleteVerifiedEmailAddress": { + "input": { + "type": "structure", + "required": [ + "EmailAddress" + ], + "members": { + "EmailAddress": {} + } + } + }, + "GetIdentityDkimAttributes": { + "input": { + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S7" + } + } + }, + "output": { + "resultWrapper": "GetIdentityDkimAttributesResult", + "type": "structure", + "required": [ + "DkimAttributes" + ], + "members": { + "DkimAttributes": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "DkimEnabled", + "DkimVerificationStatus" + ], + "members": { + "DkimEnabled": { + "type": "boolean" + }, + "DkimVerificationStatus": {}, + "DkimTokens": { + "shape": "Sd" + } + } + } + } + } + } + }, + "GetIdentityNotificationAttributes": { + "input": { + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S7" + } + } + }, + "output": { + "resultWrapper": "GetIdentityNotificationAttributesResult", + "type": "structure", + "required": [ + "NotificationAttributes" + ], + "members": { + "NotificationAttributes": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "BounceTopic", + "ComplaintTopic", + "DeliveryTopic", + "ForwardingEnabled" + ], + "members": { + "BounceTopic": {}, + "ComplaintTopic": {}, + "DeliveryTopic": {}, + "ForwardingEnabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "GetIdentityVerificationAttributes": { + "input": { + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S7" + } + } + }, + "output": { + "resultWrapper": "GetIdentityVerificationAttributesResult", + "type": "structure", + "required": [ + "VerificationAttributes" + ], + "members": { + "VerificationAttributes": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "required": [ + "VerificationStatus" + ], + "members": { + "VerificationStatus": {}, + "VerificationToken": {} + } + } + } + } + } + }, + "GetSendQuota": { + "output": { + "resultWrapper": "GetSendQuotaResult", + "type": "structure", + "members": { + "Max24HourSend": { + "type": "double" + }, + "MaxSendRate": { + "type": "double" + }, + "SentLast24Hours": { + "type": "double" + } + } + } + }, + "GetSendStatistics": { + "output": { + "resultWrapper": "GetSendStatisticsResult", + "type": "structure", + "members": { + "SendDataPoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "timestamp" + }, + "DeliveryAttempts": { + "type": "long" + }, + "Bounces": { + "type": "long" + }, + "Complaints": { + "type": "long" + }, + "Rejects": { + "type": "long" + } + } + } + } + } + } + }, + "ListIdentities": { + "input": { + "type": "structure", + "members": { + "IdentityType": {}, + "NextToken": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListIdentitiesResult", + "type": "structure", + "required": [ + "Identities" + ], + "members": { + "Identities": { + "shape": "S7" + }, + "NextToken": {} + } + } + }, + "ListVerifiedEmailAddresses": { + "output": { + "resultWrapper": "ListVerifiedEmailAddressesResult", + "type": "structure", + "members": { + "VerifiedEmailAddresses": { + "shape": "S13" + } + } + } + }, + "SendEmail": { + "input": { + "type": "structure", + "required": [ + "Source", + "Destination", + "Message" + ], + "members": { + "Source": {}, + "Destination": { + "type": "structure", + "members": { + "ToAddresses": { + "shape": "S13" + }, + "CcAddresses": { + "shape": "S13" + }, + "BccAddresses": { + "shape": "S13" + } + } + }, + "Message": { + "type": "structure", + "required": [ + "Subject", + "Body" + ], + "members": { + "Subject": { + "shape": "S17" + }, + "Body": { + "type": "structure", + "members": { + "Text": { + "shape": "S17" + }, + "Html": { + "shape": "S17" + } + } + } + } + }, + "ReplyToAddresses": { + "shape": "S13" + }, + "ReturnPath": {} + } + }, + "output": { + "resultWrapper": "SendEmailResult", + "type": "structure", + "required": [ + "MessageId" + ], + "members": { + "MessageId": {} + } + } + }, + "SendRawEmail": { + "input": { + "type": "structure", + "required": [ + "RawMessage" + ], + "members": { + "Source": {}, + "Destinations": { + "shape": "S13" + }, + "RawMessage": { + "type": "structure", + "required": [ + "Data" + ], + "members": { + "Data": { + "type": "blob" + } + } + } + } + }, + "output": { + "resultWrapper": "SendRawEmailResult", + "type": "structure", + "required": [ + "MessageId" + ], + "members": { + "MessageId": {} + } + } + }, + "SetIdentityDkimEnabled": { + "input": { + "type": "structure", + "required": [ + "Identity", + "DkimEnabled" + ], + "members": { + "Identity": {}, + "DkimEnabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SetIdentityDkimEnabledResult", + "type": "structure", + "members": {} + } + }, + "SetIdentityFeedbackForwardingEnabled": { + "input": { + "type": "structure", + "required": [ + "Identity", + "ForwardingEnabled" + ], + "members": { + "Identity": {}, + "ForwardingEnabled": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SetIdentityFeedbackForwardingEnabledResult", + "type": "structure", + "members": {} + } + }, + "SetIdentityNotificationTopic": { + "input": { + "type": "structure", + "required": [ + "Identity", + "NotificationType" + ], + "members": { + "Identity": {}, + "NotificationType": {}, + "SnsTopic": {} + } + }, + "output": { + "resultWrapper": "SetIdentityNotificationTopicResult", + "type": "structure", + "members": {} + } + }, + "VerifyDomainDkim": { + "input": { + "type": "structure", + "required": [ + "Domain" + ], + "members": { + "Domain": {} + } + }, + "output": { + "resultWrapper": "VerifyDomainDkimResult", + "type": "structure", + "required": [ + "DkimTokens" + ], + "members": { + "DkimTokens": { + "shape": "Sd" + } + } + } + }, + "VerifyDomainIdentity": { + "input": { + "type": "structure", + "required": [ + "Domain" + ], + "members": { + "Domain": {} + } + }, + "output": { + "resultWrapper": "VerifyDomainIdentityResult", + "type": "structure", + "required": [ + "VerificationToken" + ], + "members": { + "VerificationToken": {} + } + } + }, + "VerifyEmailAddress": { + "input": { + "type": "structure", + "required": [ + "EmailAddress" + ], + "members": { + "EmailAddress": {} + } + } + }, + "VerifyEmailIdentity": { + "input": { + "type": "structure", + "required": [ + "EmailAddress" + ], + "members": { + "EmailAddress": {} + } + }, + "output": { + "resultWrapper": "VerifyEmailIdentityResult", + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "S7": { + "type": "list", + "member": {} + }, + "Sd": { + "type": "list", + "member": {} + }, + "S13": { + "type": "list", + "member": {} + }, + "S17": { + "type": "structure", + "required": [ + "Data" + ], + "members": { + "Data": {}, + "Charset": {} + } + } + } +} \ No newline at end of file diff --git a/apis/email-2010-12-01.full.json b/apis/email-2010-12-01.full.json new file mode 100644 index 0000000000..da80cacf75 --- /dev/null +++ b/apis/email-2010-12-01.full.json @@ -0,0 +1,958 @@ +{ + "metadata":{ + "apiVersion":"2010-12-01", + "endpointPrefix":"email", + "serviceAbbreviation":"Amazon SES", + "serviceFullName":"Amazon Simple Email Service", + "signatureVersion":"v4", + "signingName":"ses", + "xmlNamespace":"http://ses.amazonaws.com/doc/2010-12-01/", + "protocol":"query" + }, + "documentation":"Amazon Simple Email Service\n

\n This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be\n used in conjunction with the Amazon SES Developer Guide.\n

\n For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES \n in the Amazon SES Developer Guide. \n ", + "operations":{ + "DeleteIdentity":{ + "name":"DeleteIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteIdentityRequest", + "documentation":"

Represents a request instructing the service to delete an identity from the list of identities for the AWS Account.

" + }, + "output":{ + "shape":"DeleteIdentityResponse", + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

", + "resultWrapper":"DeleteIdentityResult" + }, + "documentation":"

Deletes the specified identity (email address or domain) from the list of verified identities.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:25:58 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=w943pl3zIvtszwzZxypi+LsgjzquvhYhnG42S6b2WLo=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 135\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=DeleteIdentity\n&Identity=domain.com\n&Timestamp=2012-05-12T05%3A25%3A58.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n d96bd874-9bf2-11e1-8ee7-c98a0037a2b6\n \n\n \n \n " + }, + "DeleteVerifiedEmailAddress":{ + "name":"DeleteVerifiedEmailAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteVerifiedEmailAddressRequest", + "documentation":"

Represents a request instructing the service to delete an address from the list of verified email addresses.

" + }, + "documentation":"

Deletes the specified email address from the list of verified addresses.

\n The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release\n of Domain Verification. The DeleteIdentity action is now preferred.\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:20:50 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=Rxzyd6cQe/YjkV4yoQAZ243OzzNjFgrsclizTKwRIRc=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 142\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=DeleteVerifiedEmailAddress\n&EmailAddress=user%40example.com\n&Timestamp=2011-08-18T22%3A20%3A50.000Z\n \n \n \n \n\n \n 5634af08-c865-11e0-8986-3f99a698f914\n \n\n \n \n " + }, + "GetIdentityDkimAttributes":{ + "name":"GetIdentityDkimAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetIdentityDkimAttributesRequest", + "documentation":"

Given a list of verified identities, describes their DKIM attributes. The DKIM attributes of an email address\n identity includes whether DKIM signing is individually enabled or disabled for that address. The DKIM attributes\n of a domain name identity includes whether DKIM signing is enabled, as well as the DNS records (tokens)\n that must remain published in the domain name's DNS.

" + }, + "output":{ + "shape":"GetIdentityDkimAttributesResponse", + "documentation":"

Represents a list of all the DKIM attributes for the specified identity.

", + "resultWrapper":"GetIdentityDkimAttributesResult" + }, + "documentation":"

Returns the current status of Easy DKIM signing for an entity. For domain name\n identities, this action also returns the DKIM tokens that are required for Easy DKIM\n signing, and whether Amazon SES has successfully verified that these tokens have been\n published.

\n

This action takes a list of identities as input and returns the following\n information for each:

\n \n

This action is throttled at one request per second.

\n

For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Fri, 29 Jun 2012 22:41:32 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE, \n Signature=MJdhrIAt3c4BRC6jdzueMM+AJLEx17bnIHjZwlSenyk=, \n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 165\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetIdentityDkimAttributes\n&Identities.member.1=example.com\n&Timestamp=2012-06-29T22%3A41%3A32.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n \n amazon.com\n \n true\n Success\n \n vvjuipp74whm76gqoni7qmwwn4w4qusjiainivf6f\n 3frqe7jn4obpuxjpwpolz6ipb3k5nvt2nhjpik2oy\n wrqplteh7oodxnad7hsl4mixg2uavzneazxv5sxi2\n \n \n \n \n \n \n bb5a105d-c468-11e1-82eb-dff885ccc06a\n \n\n \n \n " + }, + "GetIdentityNotificationAttributes":{ + "name":"GetIdentityNotificationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetIdentityNotificationAttributesRequest", + "documentation":"" + }, + "output":{ + "shape":"GetIdentityNotificationAttributesResponse", + "documentation":"

Describes whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for\n bounce, complaint, and/or delivery notifications, and specifies whether feedback forwarding is\n enabled for bounce and complaint notifications.

", + "resultWrapper":"GetIdentityNotificationAttributesResult" + }, + "documentation":"

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity \n notification attributes.

\n

This action is throttled at one request per second.

\n

For more information about using notifications with Amazon SES, see the\n Amazon SES Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Fri, 15 Jun 2012 20:51:42 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=ee9aH6tUW5wBPoh01Tz3w4H+z4avrMmvmRYbfORC7OI=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 173\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetIdentityNotificationAttributes\n&Identities.member.1=user%40example.com\n&Timestamp=2012-06-15T20%3A51%3A42.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n \n user@example.com\n \n true\n arn:aws:sns:us-east-1:123456789012:example\n arn:aws:sns:us-east-1:123456789012:example\n arn:aws:sns:us-east-1:123456789012:example\n \n \n \n \n \n e038e509-b72a-11e1-901f-1fbd90e8104f\n \n\n \n \n " + }, + "GetIdentityVerificationAttributes":{ + "name":"GetIdentityVerificationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetIdentityVerificationAttributesRequest", + "documentation":"

Represents a request instructing the service to provide the verification attributes for a list of identities.

" + }, + "output":{ + "shape":"GetIdentityVerificationAttributesResponse", + "documentation":"

Represents the verification attributes for a list of identities.

", + "resultWrapper":"GetIdentityVerificationAttributesResult" + }, + "documentation":"

Given a list of identities (email addresses and/or domains), returns the verification\n status and (for domain identities) the verification token for each identity.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:27:54 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=3+KQ4VHx991T7Kb41HmFcZJxuHz4/6mf2H5FxY+tuLc=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 203\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetIdentityVerificationAttributes\n&Identities.member.1=user%40domain.com\n&Identities.member.2=domain.com\n&Timestamp=2012-05-12T05%3A27%3A54.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n \n domain.com\n \n Pending\n QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0=\n \n \n \n user@domain.com\n \n Pending\n \n \n \n \n \n 1d0c29f1-9bf3-11e1-8ee7-c98a0037a2b6\n \n\n \n \n " + }, + "GetSendQuota":{ + "name":"GetSendQuota", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetSendQuotaResponse", + "documentation":"

Represents the user's current activity limits returned from a successful\n GetSendQuota\n request.\n

", + "resultWrapper":"GetSendQuotaResult" + }, + "documentation":"

Returns the user's current sending limits.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:22:36 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=W1YdiNOtf0jN3t7Lv63qhz7UZc3RrcmQpkGbopvnj/Y=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 94\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetSendQuota\n&Timestamp=2011-08-18T22%3A22%3A36.000Z\n \n \n \n \n\n \n 127.0\n 200.0\n 1.0\n \n \n 273021c6-c866-11e0-b926-699e21c3af9e\n \n\n \n \n " + }, + "GetSendStatistics":{ + "name":"GetSendStatistics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetSendStatisticsResponse", + "documentation":"

Represents a list of\n SendDataPoint\n items returned from a successful\n GetSendStatistics\n request. This list contains aggregated data from the previous two weeks of sending activity.\n

", + "resultWrapper":"GetSendStatisticsResult" + }, + "documentation":"

Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of\n sending activity.\n

\n

Each data point in the list contains statistics for a 15-minute interval.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:23:01 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=kwuk4eraA9HSfHySflgDKR6xK0JXjATIE7Uu5/FB4x4=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 99\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetSendStatistics\n&Timestamp=2011-08-18T22%3A23%3A01.000Z\n \n \n \n \n\n \n \n \n 8\n 2011-08-03T19:23:00Z\n 0\n 0\n 0\n \n \n 7\n 2011-08-03T06:53:00Z\n 0\n 0\n 0\n \n\t .\n\t .\n\t .\n\t .\n \n \n c2b66ee5-c866-11e0-b17f-cddb0ab334db\n \n\n \n \n " + }, + "ListIdentities":{ + "name":"ListIdentities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListIdentitiesRequest", + "documentation":"

Represents a request instructing the service to list all identities for the AWS Account.

" + }, + "output":{ + "shape":"ListIdentitiesResponse", + "documentation":"

Represents a list of all verified identities for the AWS Account.

", + "resultWrapper":"ListIdentitiesResult" + }, + "documentation":"

Returns a list containing all of the identities (email addresses and domains) for \n a specific AWS Account, regardless of verification status.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:18:45 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=OruiFNV26DCZicLDaQmULHGbjbU8MbC/c5aIo/MMIuM=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 115\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=ListIdentities\n&Timestamp=2012-05-12T05%3A18%3A45.000Z&\nVersion=2010-12-01\n \n \n \n \n\n \n \n example.com\n user@example.com\n \n \n \n cacecf23-9bf1-11e1-9279-0100e8cf109a\n \n\n \n \n " + }, + "ListVerifiedEmailAddresses":{ + "name":"ListVerifiedEmailAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"ListVerifiedEmailAddressesResponse", + "documentation":"

Represents a list of all the email addresses verified for the current user.

", + "resultWrapper":"ListVerifiedEmailAddressesResult" + }, + "documentation":"

Returns a list containing all of the email addresses that have been verified.

\n The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of \n Domain Verification. The ListIdentities action is now preferred.\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:05:09 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=II0+vvDKGMv71vToBwzR6vZ1hxe/VUE8tWEFUNTUqgE=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 108\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=ListVerifiedEmailAddresses\n&Timestamp=2011-08-18T22%3A05%3A09.000Z%\n \n \n \n \n\n \n \n example@amazon.com\n \n \n \n 3dd50e97-c865-11e0-b235-099eb63d928d\n \n\n \n \n " + }, + "SendEmail":{ + "name":"SendEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SendEmailRequest", + "documentation":"

Represents a request instructing the service to send a single email message.

\n

This datatype can be used in application code to compose a message consisting of source, destination, message, reply-to, and return-path\n parts. This object can then be sent using the\n SendEmail\n action.\n

" + }, + "output":{ + "shape":"SendEmailResponse", + "documentation":"

Represents a unique message ID returned from a successful\n SendEmail\n request.\n

", + "resultWrapper":"SendEmailResult" + }, + "errors":[ + { + "shape":"MessageRejected", + "error":{ + "code":"MessageRejected", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Indicates that the action failed, and the message could not be sent. Check the error stack for more\n information about what caused the error." + } + ], + "documentation":"

Composes an email message based on input data, and then immediately queues the message\n for sending.\n

\n \n You can only send email from verified email addresses and domains. \n If you have not requested production access to Amazon SES, you must also \n verify every recipient email address except for the recipients provided \n by the Amazon SES mailbox simulator. For more information, go to the\n Amazon SES\n Developer Guide.\n \n

The total size of the message cannot exceed 10 MB.

\n

Amazon SES has a limit on the total number of recipients per message: The combined number\n of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email\n message to a larger audience, you can divide your recipient list into groups of 50 or\n fewer, and then call Amazon SES repeatedly to send the message to each group.\n

\n

For every message that you send, the total number of recipients (To:, CC: and BCC:) is\n counted against your\n sending quota\n - the maximum number of emails you can send in\n a 24-hour period. For information about your sending quota, go to the Amazon SES\n Developer Guide.\n

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:25:27 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=yXx/wM1bESLuDErJ6HpZg9JK8Gjau7EUe4FWEfmhodo=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 230\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SendEmail\n&Destination.ToAddresses.member.1=allan%40example.com\n&Message.Body.Text.Data=body\n&Message.Subject.Data=Example&Source=user%40example.com\n&Timestamp=2011-08-18T22%3A25%3A27.000Z\n \n \n \n \n\n \n 00000131d51d2292-159ad6eb-077c-46e6-ad09-ae7c05925ed4-000000\n \n \n d5964849-c866-11e0-9beb-01a62d68c57f\n \n\n \n \n " + }, + "SendRawEmail":{ + "name":"SendRawEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SendRawEmailRequest", + "documentation":"

Represents a request instructing the service to send a raw email message.

\n

This datatype can be used in application code to compose a message consisting of source, destination, and raw message text. This object can\n then be sent using the\n SendRawEmail\n action.\n

" + }, + "output":{ + "shape":"SendRawEmailResponse", + "documentation":"

Represents a unique message ID returned from a successful\n SendRawEmail\n request.\n

", + "resultWrapper":"SendRawEmailResult" + }, + "errors":[ + { + "shape":"MessageRejected", + "error":{ + "code":"MessageRejected", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Indicates that the action failed, and the message could not be sent. Check the error stack for more\n information about what caused the error." + } + ], + "documentation":"

Sends an email message, with header and content specified by the client. The\n SendRawEmail\n action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet\n email standards; otherwise, the message cannot be sent.\n

\n \n You can only send email from verified email addresses and domains. \n If you have not requested production access to Amazon SES, you must also \n verify every recipient email address except for the recipients provided \n by the Amazon SES mailbox simulator. For more information, go to the\n Amazon SES\n Developer Guide.\n \n

The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

\n

Amazon SES has a limit on the total number of recipients per message: The combined number\n of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email\n message to a larger audience, you can divide your recipient list into groups of 50 or\n fewer, and then call Amazon SES repeatedly to send the message to each group.\n

\n

The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list \n counts towards the 50-recipient limit.\n

\n

For every message that you send, the total number of recipients (To:, CC: and BCC:) is\n counted against your\n sending quota\n - the maximum number of emails you can send in\n a 24-hour period. For information about your sending quota, go to the Amazon SES\n Developer Guide.\n

\n \n \n \nPOST / HTTP/1.1\nDate: Wed, 17 Aug 2011 00:21:38 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=uN0lHIf14tmMBzwnkHzaWBLrBFvJAvyXCsfSYAvwLuc=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 230\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SendRawEmail\n&RawMessage.Data=U3ViamVjdDogRXhhbXBsZQpGcm9tOiBleGFtcGxlQGFtYXpvbi5jb20KVG8\n6IGV4YW1wbGVAYW1h%0Aem9uLmNvbQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9hbHRlcm5hdGl2\nZTsgYm91bmRhcnk9MDAx%0ANmU2OGY5ZDkyOWNiMDk2MDRhYWE4MzA0MgoKLS0wMDE2ZTY4ZjlkO\nTI5Y2IwOTYwNGFhYTgzMDQy%0ACkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD1JU0\n8tODg1OS0xCgpCb2R5LgoKLS0w%0AMDE2ZTY4ZjlkOTI5Y2IwOTYwNGFhYTgzMDQyCkNvbnRlbnQ\ntVHlwZTogdGV4dC9odG1sOyBjaGFy%0Ac2V0PUlTTy04ODU5LTEKCkJvZHkuPGJyPgoKLS0wMDE2\nZTY4ZjlkOTI5Y2IwOTYwNGFhYTgzMDQy%0ALS0%3D%0A\n&Timestamp=2011-08-17T00%3A21%3A38.000Z\n \n \n \n \n\n \n 00000131d51d6b36-1d4f9293-0aee-4503-b573-9ae4e70e9e38-000000\n \n \n e0abcdfa-c866-11e0-b6d0-273d09173b49\n \n\n \n \n " + }, + "SetIdentityDkimEnabled":{ + "name":"SetIdentityDkimEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetIdentityDkimEnabledRequest", + "documentation":"

Represents a request instructing the service to enable or disable DKIM signing for an identity.

" + }, + "output":{ + "shape":"SetIdentityDkimEnabledResponse", + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

", + "resultWrapper":"SetIdentityDkimEnabledResult" + }, + "documentation":"

Enables or disables Easy DKIM signing of email sent from an identity:

\n \n

For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the\n corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or \n the VerifyDomainDkim action.

\n

This action is throttled at one request per second.

\n

For more information about Easy DKIM signing, go to the \n Amazon SES Developer Guide.

\n \n \n \n \nPOST / HTTP/1.1\nDate: Fri, 29 Jun 2012 22:42:08 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=u/hDNhYm87AV7LAPzouTBz6HJxUEuE5k96sLzYHjR24=, \n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 168\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SetIdentityDkimEnabled\n&DkimEnabled=true&Identity=user%40example.com\n&Timestamp=2012-06-29T22%3A42%3A08.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n 7aa61362-c469-11e1-aee5-6bbb4608fbcc\n \n\n \n \n " + }, + "SetIdentityFeedbackForwardingEnabled":{ + "name":"SetIdentityFeedbackForwardingEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetIdentityFeedbackForwardingEnabledRequest"}, + "output":{ + "shape":"SetIdentityFeedbackForwardingEnabledResponse", + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

", + "resultWrapper":"SetIdentityFeedbackForwardingEnabledResult" + }, + "documentation":"

Given an identity (email address or domain), enables or disables whether Amazon SES forwards\n bounce and complaint notifications as email. Feedback forwarding can only be disabled when\n Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

\n Feedback forwarding does not apply to delivery notifications.\n Delivery notifications are only available through Amazon SNS.\n

This action is throttled at one request per second.

\n

For more information about using notifications with Amazon SES,\n see the Amazon SES Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Fri, 15 Jun 2012 20:31:21 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=juNpmD6UJaN+r7gcLa2ZNZpO3AmF1ZfOkD6PgxgNhRA=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 188\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SetIdentityFeedbackForwardingEnabled\n&ForwardingEnabled=true\n&Identity=user%40example.com\n&Timestamp=2012-06-15T20%3A31%3A21.000Z\n&Version=2010-12-01\n\n \n \n \n \n\n \n \n 299f4af4-b72a-11e1-901f-1fbd90e8104f\n \n\n \n \n " + }, + "SetIdentityNotificationTopic":{ + "name":"SetIdentityNotificationTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetIdentityNotificationTopicRequest", + "documentation":"

Represents a request to set or clear an identity's notification topic.

" + }, + "output":{ + "shape":"SetIdentityNotificationTopicResponse", + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

", + "resultWrapper":"SetIdentityNotificationTopicResult" + }, + "documentation":"

Given an identity (email address or domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish\n bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.

\n Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications.\n For more information, see SetIdentityFeedbackForwardingEnabled.\n \n

This action is throttled at one request per second.

\n

For more information about feedback notification, see the\n Amazon SES Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:27:54 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=3+KQ4VHx991T7Kb41HmFcZJxuHz4/6mf2H5FxY+tuLc=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 203\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SetIdentityNotificationTopic\n&Identity=user@example.com\n&SnsTopic=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3Aexample\n&NotificationType=Bounce\n&Timestamp=2012-05-12T05%3A27%3A54.000Z&Version=2010-12-01\n \n \n \n \n\n \n \n 299f4af4-b72a-11e1-901f-1fbd90e8104f\n \n\n \n \n " + }, + "VerifyDomainDkim":{ + "name":"VerifyDomainDkim", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"VerifyDomainDkimRequest", + "documentation":"

Represents a request instructing the service to begin DKIM verification for a domain.

" + }, + "output":{ + "shape":"VerifyDomainDkimResponse", + "documentation":"

Represents the DNS records that must be published in the domain name's DNS to complete\n DKIM setup.

", + "resultWrapper":"VerifyDomainDkimResult" + }, + "documentation":"

Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that\n represent your domain's identity. Using these tokens, you will need to create DNS CNAME\n records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will\n eventually detect that you have updated your DNS records; this detection process may\n take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign\n email originating from that domain.

\n

This action is throttled at one request per second.

\n

To enable or disable Easy DKIM signing for\n a domain, use the SetIdentityDkimEnabled action.

\n

For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Fri, 29 Jun 2012 22:43:30 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=roXhd+JhEjeBBo5tSERhrptRHSw4XHz6Ra4BXyHIduk=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 136\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=VerifyDomainDkim\n&Domain=example.com\n&Timestamp=2012-06-29T22%3A43%3A30.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n vvjuipp74whm76gqoni7qmwwn4w4qusjiainivf6sf\n 3frqe7jn4obpuxjpwpolz6ipb3k5nvt2nhjpik2oy\n wrqplteh7oodxnad7hsl4mixg2uavzneazxv5sxi2\n \n \n \n 9662c15b-c469-11e1-99d1-797d6ecd6414\n \n\n\n \n " + }, + "VerifyDomainIdentity":{ + "name":"VerifyDomainIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"VerifyDomainIdentityRequest", + "documentation":"

Represents a request instructing the service to begin domain verification.

" + }, + "output":{ + "shape":"VerifyDomainIdentityResponse", + "documentation":"

Represents a token used for domain ownership verification.

", + "resultWrapper":"VerifyDomainIdentityResult" + }, + "documentation":"

Verifies a domain.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:24:02 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=Wr+6RCfV+QgjLki2dtIrlecMK9+RrsDaTG5uWneDAu8=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 139\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=VerifyDomainIdentity\n&Domain=domain.com\n&Timestamp=2012-05-12T05%3A24%3A02.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0=\n \n \n 94f6368e-9bf2-11e1-8ee7-c98a0037a2b6\n \n\n \n \n " + }, + "VerifyEmailAddress":{ + "name":"VerifyEmailAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"VerifyEmailAddressRequest", + "documentation":"

Represents a request instructing the service to begin email address verification.

" + }, + "documentation":"

Verifies an email address. This action causes a confirmation email message to be \n sent to the specified address.

\n The VerifyEmailAddress action is deprecated as of the May 15, 2012 release\n of Domain Verification. The VerifyEmailIdentity action is now preferred.\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:28:27 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=o9NK68jraFg5BnaTQiQhpxj2x1dGONOEFHHgsM6o5as=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 132\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=VerifyEmailAddress\n&EmailAddress=user%40example.com\n&Timestamp=2011-08-18T22%3A28%3A27.000Z\n \n \n \n \n\n \n 8edd7eb2-c864-11e0-9f8f-3da8fc215a7e\n \n\n \n \n " + }, + "VerifyEmailIdentity":{ + "name":"VerifyEmailIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"VerifyEmailIdentityRequest", + "documentation":"

Represents a request instructing the service to begin email address verification.

" + }, + "output":{ + "shape":"VerifyEmailIdentityResponse", + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

", + "resultWrapper":"VerifyEmailIdentityResult" + }, + "documentation":"

Verifies an email address. This action causes a confirmation email message\n to be sent to the specified address.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:21:58 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 151\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=VerifyEmailIdentity\n&EmailAddress=user%40domain.com\n&Timestamp=2012-05-12T05%3A21%3A58.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n 47e0ef1a-9bf2-11e1-9279-0100e8cf109a\n \n\n \n \n " + } + }, + "shapes":{ + "Address":{"type":"string"}, + "AddressList":{ + "type":"list", + "member":{"shape":"Address"} + }, + "Body":{ + "type":"structure", + "members":{ + "Text":{ + "shape":"Content", + "documentation":"

The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile\n devices).\n

" + }, + "Html":{ + "shape":"Content", + "documentation":"

The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted\n text, and much more in an HTML message.\n

" + } + }, + "documentation":"

Represents the body of the message. You can specify text, HTML, or both. If you use both, then\n the message should display correctly in the widest variety of email clients.\n

" + }, + "Charset":{"type":"string"}, + "Content":{ + "type":"structure", + "required":["Data"], + "members":{ + "Data":{ + "shape":"MessageData", + "documentation":"

The textual data of the content.

" + }, + "Charset":{ + "shape":"Charset", + "documentation":"

The character set of the content.

" + } + }, + "documentation":"

Represents textual data, plus an optional character set specification.

\n

By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must\n contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1,\n and Shift_JIS.\n

" + }, + "Counter":{"type":"long"}, + "DeleteIdentityRequest":{ + "type":"structure", + "required":["Identity"], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

The identity to be removed from the list of identities for the AWS Account.

" + } + }, + "documentation":"

Represents a request instructing the service to delete an identity from the list of identities for the AWS Account.

" + }, + "DeleteIdentityResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

" + }, + "DeleteVerifiedEmailAddressRequest":{ + "type":"structure", + "required":["EmailAddress"], + "members":{ + "EmailAddress":{ + "shape":"Address", + "documentation":"

An email address to be removed from the list of verified addresses.

" + } + }, + "documentation":"

Represents a request instructing the service to delete an address from the list of verified email addresses.

" + }, + "Destination":{ + "type":"structure", + "members":{ + "ToAddresses":{ + "shape":"AddressList", + "documentation":"

The To: field(s) of the message.

" + }, + "CcAddresses":{ + "shape":"AddressList", + "documentation":"

The CC: field(s) of the message.

" + }, + "BccAddresses":{ + "shape":"AddressList", + "documentation":"

The BCC: field(s) of the message.

" + } + }, + "documentation":"

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

\n

\n By default, the string must be 7-bit ASCII. If the text must contain any other characters, \n then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. \n MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. \n For more information, see RFC 2047.\n

" + }, + "DkimAttributes":{ + "type":"map", + "key":{"shape":"Identity"}, + "value":{"shape":"IdentityDkimAttributes"} + }, + "Domain":{"type":"string"}, + "Enabled":{"type":"boolean"}, + "GetIdentityDkimAttributesRequest":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

A list of one or more verified identities - email addresses, domains, or both.

" + } + }, + "documentation":"

Given a list of verified identities, describes their DKIM attributes. The DKIM attributes of an email address\n identity includes whether DKIM signing is individually enabled or disabled for that address. The DKIM attributes\n of a domain name identity includes whether DKIM signing is enabled, as well as the DNS records (tokens)\n that must remain published in the domain name's DNS.

" + }, + "GetIdentityDkimAttributesResponse":{ + "type":"structure", + "required":["DkimAttributes"], + "members":{ + "DkimAttributes":{ + "shape":"DkimAttributes", + "documentation":"

The DKIM attributes for an email address or a domain.

" + } + }, + "documentation":"

Represents a list of all the DKIM attributes for the specified identity.

" + }, + "GetIdentityNotificationAttributesRequest":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

A list of one or more identities.

" + } + }, + "documentation":"" + }, + "GetIdentityNotificationAttributesResponse":{ + "type":"structure", + "required":["NotificationAttributes"], + "members":{ + "NotificationAttributes":{ + "shape":"NotificationAttributes", + "documentation":"

A map of Identity to IdentityNotificationAttributes.

" + } + }, + "documentation":"

Describes whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for\n bounce, complaint, and/or delivery notifications, and specifies whether feedback forwarding is\n enabled for bounce and complaint notifications.

" + }, + "GetIdentityVerificationAttributesRequest":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

A list of identities.

" + } + }, + "documentation":"

Represents a request instructing the service to provide the verification attributes for a list of identities.

" + }, + "GetIdentityVerificationAttributesResponse":{ + "type":"structure", + "required":["VerificationAttributes"], + "members":{ + "VerificationAttributes":{ + "shape":"VerificationAttributes", + "documentation":"

A map of Identities to IdentityVerificationAttributes objects.

" + } + }, + "documentation":"

Represents the verification attributes for a list of identities.

" + }, + "GetSendQuotaResponse":{ + "type":"structure", + "members":{ + "Max24HourSend":{ + "shape":"Max24HourSend", + "documentation":"

The maximum number of emails the user is allowed to send in a 24-hour interval.

" + }, + "MaxSendRate":{ + "shape":"MaxSendRate", + "documentation":"

The maximum number of emails the user is allowed to send per second.

" + }, + "SentLast24Hours":{ + "shape":"SentLast24Hours", + "documentation":"

The number of emails sent during the previous 24 hours.

" + } + }, + "documentation":"

Represents the user's current activity limits returned from a successful\n GetSendQuota\n request.\n

" + }, + "GetSendStatisticsResponse":{ + "type":"structure", + "members":{ + "SendDataPoints":{ + "shape":"SendDataPointList", + "documentation":"

A list of data points, each of which represents 15 minutes of activity.

" + } + }, + "documentation":"

Represents a list of\n SendDataPoint\n items returned from a successful\n GetSendStatistics\n request. This list contains aggregated data from the previous two weeks of sending activity.\n

" + }, + "Identity":{"type":"string"}, + "IdentityDkimAttributes":{ + "type":"structure", + "required":[ + "DkimEnabled", + "DkimVerificationStatus" + ], + "members":{ + "DkimEnabled":{ + "shape":"Enabled", + "documentation":"

True if DKIM signing is enabled for email sent from the identity; false otherwise.

" + }, + "DkimVerificationStatus":{ + "shape":"VerificationStatus", + "documentation":"

Describes whether Amazon SES has successfully verified the DKIM DNS records\n (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

" + }, + "DkimTokens":{ + "shape":"VerificationTokenList", + "documentation":"

A set of character strings that represent the domain's identity. Using these tokens, you\n will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon\n SES. Amazon Web Services will eventually detect that you have updated your DNS records;\n this detection process may take up to 72 hours. Upon successful detection, Amazon SES\n will be able to DKIM-sign email originating from that domain. (This only applies to\n domain identities, not email address identities.)

\n

For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.

" + } + }, + "documentation":"

Represents the DKIM attributes of a verified email address or a domain.

" + }, + "IdentityList":{ + "type":"list", + "member":{"shape":"Identity"} + }, + "IdentityNotificationAttributes":{ + "type":"structure", + "required":[ + "BounceTopic", + "ComplaintTopic", + "DeliveryTopic", + "ForwardingEnabled" + ], + "members":{ + "BounceTopic":{ + "shape":"NotificationTopic", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic\n where Amazon SES will publish bounce notifications.

" + }, + "ComplaintTopic":{ + "shape":"NotificationTopic", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic\n where Amazon SES will publish complaint notifications.

" + }, + "DeliveryTopic":{ + "shape":"NotificationTopic", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic\n where Amazon SES will publish delivery notifications.

" + }, + "ForwardingEnabled":{ + "shape":"Enabled", + "documentation":"

Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates\n that Amazon SES will forward bounce and complaint notifications as email, while false indicates that\n bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.

" + } + }, + "documentation":"

Represents the notification attributes of an identity, including whether an identity has Amazon Simple\n Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications,\n and whether feedback forwarding is enabled for bounce and complaint notifications.

" + }, + "IdentityType":{ + "type":"string", + "enum":[ + "EmailAddress", + "Domain" + ] + }, + "IdentityVerificationAttributes":{ + "type":"structure", + "required":["VerificationStatus"], + "members":{ + "VerificationStatus":{ + "shape":"VerificationStatus", + "documentation":"

The verification status of the identity: \"Pending\", \"Success\", \"Failed\", or \"TemporaryFailure\".

" + }, + "VerificationToken":{ + "shape":"VerificationToken", + "documentation":"

The verification token for a domain identity. Null for email address identities.

" + } + }, + "documentation":"

Represents the verification attributes of a single identity.

" + }, + "ListIdentitiesRequest":{ + "type":"structure", + "members":{ + "IdentityType":{ + "shape":"IdentityType", + "documentation":"

The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use for pagination.

" + }, + "MaxItems":{ + "shape":"MaxItems", + "documentation":"

The maximum number of identities per page. Possible values are 1-100 inclusive.

" + } + }, + "documentation":"

Represents a request instructing the service to list all identities for the AWS Account.

" + }, + "ListIdentitiesResponse":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

A list of identities.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used for pagination.

" + } + }, + "documentation":"

Represents a list of all verified identities for the AWS Account.

" + }, + "ListVerifiedEmailAddressesResponse":{ + "type":"structure", + "members":{ + "VerifiedEmailAddresses":{ + "shape":"AddressList", + "documentation":"

A list of email addresses that have been verified.

" + } + }, + "documentation":"

Represents a list of all the email addresses verified for the current user.

" + }, + "Max24HourSend":{"type":"double"}, + "MaxItems":{"type":"integer"}, + "MaxSendRate":{"type":"double"}, + "Message":{ + "type":"structure", + "required":[ + "Subject", + "Body" + ], + "members":{ + "Subject":{ + "shape":"Content", + "documentation":"

The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

" + }, + "Body":{ + "shape":"Body", + "documentation":"

The message body.

" + } + }, + "documentation":"

Represents the message to be sent, composed of a subject and a body.

" + }, + "MessageData":{"type":"string"}, + "MessageId":{"type":"string"}, + "MessageRejected":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"MessageRejected", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Indicates that the action failed, and the message could not be sent. Check the error stack for more\n information about what caused the error." + }, + "NextToken":{"type":"string"}, + "NotificationAttributes":{ + "type":"map", + "key":{"shape":"Identity"}, + "value":{"shape":"IdentityNotificationAttributes"} + }, + "NotificationTopic":{"type":"string"}, + "NotificationType":{ + "type":"string", + "enum":[ + "Bounce", + "Complaint", + "Delivery" + ] + }, + "RawMessage":{ + "type":"structure", + "required":["Data"], + "members":{ + "Data":{ + "shape":"RawMessageData", + "documentation":"

The raw data of the message. The client must ensure that the message format complies with Internet email\n standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary).\n

\n

The To:, CC:, and BCC: headers in the raw message can contain a group list.\n

\n

For more information, go to the Amazon SES Developer Guide.\n

" + } + }, + "documentation":"

Represents the raw data of the message.

" + }, + "RawMessageData":{"type":"blob"}, + "SendDataPoint":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Time of the data point.

" + }, + "DeliveryAttempts":{ + "shape":"Counter", + "documentation":"

Number of emails that have been enqueued for sending.

" + }, + "Bounces":{ + "shape":"Counter", + "documentation":"

Number of emails that have bounced.

" + }, + "Complaints":{ + "shape":"Counter", + "documentation":"

Number of unwanted emails that were rejected by recipients.

" + }, + "Rejects":{ + "shape":"Counter", + "documentation":"

Number of emails rejected by Amazon SES.

" + } + }, + "documentation":"

Represents sending statistics data. Each\n SendDataPoint\n contains statistics for a 15-minute period of sending activity.\n

" + }, + "SendDataPointList":{ + "type":"list", + "member":{"shape":"SendDataPoint"} + }, + "SendEmailRequest":{ + "type":"structure", + "required":[ + "Source", + "Destination", + "Message" + ], + "members":{ + "Source":{ + "shape":"Address", + "documentation":"

The identity's email address.

\n

\n By default, the string must be 7-bit ASCII. If the text must contain any other characters, \n then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. \n MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. \n For more information, see RFC 2047.\n

" + }, + "Destination":{ + "shape":"Destination", + "documentation":"

The destination for this email, composed of To:, CC:, and BCC: fields.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

The message to be sent.

" + }, + "ReplyToAddresses":{ + "shape":"AddressList", + "documentation":"

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address\n will receive the reply.\n

" + }, + "ReturnPath":{ + "shape":"Address", + "documentation":"

The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the\n recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded\n to the email address specified by the\n ReturnPath\n parameter.\n

" + } + }, + "documentation":"

Represents a request instructing the service to send a single email message.

\n

This datatype can be used in application code to compose a message consisting of source, destination, message, reply-to, and return-path\n parts. This object can then be sent using the\n SendEmail\n action.\n

" + }, + "SendEmailResponse":{ + "type":"structure", + "required":["MessageId"], + "members":{ + "MessageId":{ + "shape":"MessageId", + "documentation":"

The unique message identifier returned from the\n SendEmail\n action.\n

" + } + }, + "documentation":"

Represents a unique message ID returned from a successful\n SendEmail\n request.\n

" + }, + "SendRawEmailRequest":{ + "type":"structure", + "required":["RawMessage"], + "members":{ + "Source":{ + "shape":"Address", + "documentation":"

The identity's email address.

\n

\n By default, the string must be 7-bit ASCII. If the text must contain any other characters, \n then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. \n MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. \n For more information, see RFC 2047.\n

\n If you specify the\n Source\n parameter and have feedback forwarding enabled, then bounces and\n complaints will be sent to this email address. This takes precedence over any\n Return-Path\n header that you might include in the raw text of the message.\n " + }, + "Destinations":{ + "shape":"AddressList", + "documentation":"

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

" + }, + "RawMessage":{ + "shape":"RawMessage", + "documentation":"

The raw text of the message. The client is responsible for ensuring the following:

\n

\n

\n

" + } + }, + "documentation":"

Represents a request instructing the service to send a raw email message.

\n

This datatype can be used in application code to compose a message consisting of source, destination, and raw message text. This object can\n then be sent using the\n SendRawEmail\n action.\n

" + }, + "SendRawEmailResponse":{ + "type":"structure", + "required":["MessageId"], + "members":{ + "MessageId":{ + "shape":"MessageId", + "documentation":"

The unique message identifier returned from the\n SendRawEmail\n action.\n

" + } + }, + "documentation":"

Represents a unique message ID returned from a successful\n SendRawEmail\n request.\n

" + }, + "SentLast24Hours":{"type":"double"}, + "SetIdentityDkimEnabledRequest":{ + "type":"structure", + "required":[ + "Identity", + "DkimEnabled" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

The identity for which DKIM signing should be enabled or disabled.

" + }, + "DkimEnabled":{ + "shape":"Enabled", + "documentation":"

Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; \n false to disable it.

" + } + }, + "documentation":"

Represents a request instructing the service to enable or disable DKIM signing for an identity.

" + }, + "SetIdentityDkimEnabledResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

" + }, + "SetIdentityFeedbackForwardingEnabledRequest":{ + "type":"structure", + "required":[ + "Identity", + "ForwardingEnabled" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

The identity for which to set bounce and complaint notification forwarding.\n Examples: user@example.com, example.com.

" + }, + "ForwardingEnabled":{ + "shape":"Enabled", + "documentation":"

Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies\n that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing\n otherwise specified. false specifies that Amazon SES\n will publish bounce and complaint notifications only through Amazon SNS. This value can only be\n set to false when Amazon SNS topics are set for both Bounce and\n Complaint notification types.

" + } + } + }, + "SetIdentityFeedbackForwardingEnabledResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

" + }, + "SetIdentityNotificationTopicRequest":{ + "type":"structure", + "required":[ + "Identity", + "NotificationType" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

The identity for which the Amazon SNS topic will be set. Examples: user@example.com, example.com.

" + }, + "NotificationType":{ + "shape":"NotificationType", + "documentation":"

The type of notifications that will be published to the specified Amazon SNS topic.

" + }, + "SnsTopic":{ + "shape":"NotificationTopic", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic.\n If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

" + } + }, + "documentation":"

Represents a request to set or clear an identity's notification topic.

" + }, + "SetIdentityNotificationTopicResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

" + }, + "Timestamp":{"type":"timestamp"}, + "VerificationAttributes":{ + "type":"map", + "key":{"shape":"Identity"}, + "value":{"shape":"IdentityVerificationAttributes"} + }, + "VerificationStatus":{ + "type":"string", + "enum":[ + "Pending", + "Success", + "Failed", + "TemporaryFailure", + "NotStarted" + ] + }, + "VerificationToken":{"type":"string"}, + "VerificationTokenList":{ + "type":"list", + "member":{"shape":"VerificationToken"} + }, + "VerifyDomainDkimRequest":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"Domain", + "documentation":"

The name of the domain to be verified for Easy DKIM signing.

" + } + }, + "documentation":"

Represents a request instructing the service to begin DKIM verification for a domain.

" + }, + "VerifyDomainDkimResponse":{ + "type":"structure", + "required":["DkimTokens"], + "members":{ + "DkimTokens":{ + "shape":"VerificationTokenList", + "documentation":"

A set of character strings that represent the domain's identity. If the identity is an\n email address, the tokens represent the domain of that address.

\n

Using these tokens, you will need to create DNS CNAME records that point to DKIM public\n keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have\n updated your DNS records; this detection process may take up to 72 hours. Upon\n successful detection, Amazon SES will be able to DKIM-sign emails originating from that\n domain.

\n

For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.

" + } + }, + "documentation":"

Represents the DNS records that must be published in the domain name's DNS to complete\n DKIM setup.

" + }, + "VerifyDomainIdentityRequest":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"Domain", + "documentation":"

The domain to be verified.

" + } + }, + "documentation":"

Represents a request instructing the service to begin domain verification.

" + }, + "VerifyDomainIdentityResponse":{ + "type":"structure", + "required":["VerificationToken"], + "members":{ + "VerificationToken":{ + "shape":"VerificationToken", + "documentation":"

A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.

" + } + }, + "documentation":"

Represents a token used for domain ownership verification.

" + }, + "VerifyEmailAddressRequest":{ + "type":"structure", + "required":["EmailAddress"], + "members":{ + "EmailAddress":{ + "shape":"Address", + "documentation":"

The email address to be verified.

" + } + }, + "documentation":"

Represents a request instructing the service to begin email address verification.

" + }, + "VerifyEmailIdentityRequest":{ + "type":"structure", + "required":["EmailAddress"], + "members":{ + "EmailAddress":{ + "shape":"Address", + "documentation":"

The email address to be verified.

" + } + }, + "documentation":"

Represents a request instructing the service to begin email address verification.

" + }, + "VerifyEmailIdentityResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An empty element. Receiving this element indicates that the request completed successfully.

" + } + } +} diff --git a/apis/email-2010-12-01.paginators.json b/apis/email-2010-12-01.paginators.json new file mode 100644 index 0000000000..e12811f5e1 --- /dev/null +++ b/apis/email-2010-12-01.paginators.json @@ -0,0 +1,13 @@ +{ + "pagination": { + "ListIdentities": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxItems", + "result_key": "Identities" + }, + "ListVerifiedEmailAddresses": { + "result_key": "VerifiedEmailAddresses" + } + } +} diff --git a/apis/email-2010-12-01.waiters.json b/apis/email-2010-12-01.waiters.json new file mode 100644 index 0000000000..e8724fc75a --- /dev/null +++ b/apis/email-2010-12-01.waiters.json @@ -0,0 +1,14 @@ +{ + "waiters": { + "__default__": { + "interval": 3, + "max_attempts": 20 + }, + "IdentityExists": { + "operation": "GetIdentityVerificationAttributes", + "success_type": "output", + "success_path": "VerificationAttributes[].VerificationStatus", + "success_value": true + } + } +} diff --git a/apis/glacier-2012-06-01.api.json b/apis/glacier-2012-06-01.api.json new file mode 100644 index 0000000000..20a6918ad8 --- /dev/null +++ b/apis/glacier-2012-06-01.api.json @@ -0,0 +1,846 @@ +{ + "metadata": { + "apiVersion": "2012-06-01", + "checksumFormat": "sha256", + "endpointPrefix": "glacier", + "serviceFullName": "Amazon Glacier", + "signatureVersion": "v4", + "protocol": "rest-json" + }, + "operations": { + "AbortMultipartUpload": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "uploadId": { + "location": "uri", + "locationName": "uploadId" + } + }, + "required": [ + "accountId", + "vaultName", + "uploadId" + ] + } + }, + "CompleteMultipartUpload": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "uploadId": { + "location": "uri", + "locationName": "uploadId" + }, + "archiveSize": { + "location": "header", + "locationName": "x-amz-archive-size" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + } + }, + "required": [ + "accountId", + "vaultName", + "uploadId" + ] + }, + "output": { + "shape": "S4" + } + }, + "CreateVault": { + "http": { + "method": "PUT", + "requestUri": "/{accountId}/vaults/{vaultName}", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + }, + "required": [ + "accountId", + "vaultName" + ] + }, + "output": { + "type": "structure", + "members": { + "location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "DeleteArchive": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}/archives/{archiveId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "archiveId": { + "location": "uri", + "locationName": "archiveId" + } + }, + "required": [ + "accountId", + "vaultName", + "archiveId" + ] + } + }, + "DeleteVault": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + }, + "required": [ + "accountId", + "vaultName" + ] + } + }, + "DeleteVaultNotifications": { + "http": { + "method": "DELETE", + "requestUri": "/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + }, + "required": [ + "accountId", + "vaultName" + ] + } + }, + "DescribeJob": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/jobs/{jobId}" + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "jobId": { + "location": "uri", + "locationName": "jobId" + } + }, + "required": [ + "accountId", + "vaultName", + "jobId" + ] + }, + "output": { + "shape": "Sb" + } + }, + "DescribeVault": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}" + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + }, + "required": [ + "accountId", + "vaultName" + ] + }, + "output": { + "shape": "Sj" + } + }, + "GetJobOutput": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/jobs/{jobId}/output" + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "jobId": { + "location": "uri", + "locationName": "jobId" + }, + "range": { + "location": "header", + "locationName": "Range" + } + }, + "required": [ + "accountId", + "vaultName", + "jobId" + ] + }, + "output": { + "type": "structure", + "members": { + "body": { + "shape": "Sn" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "status": { + "location": "statusCode", + "type": "integer" + }, + "contentRange": { + "location": "header", + "locationName": "Content-Range" + }, + "acceptRanges": { + "location": "header", + "locationName": "Accept-Ranges" + }, + "contentType": { + "location": "header", + "locationName": "Content-Type" + }, + "archiveDescription": { + "location": "header", + "locationName": "x-amz-archive-description" + } + }, + "payload": "body" + } + }, + "GetVaultNotifications": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/notification-configuration" + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + } + }, + "required": [ + "accountId", + "vaultName" + ] + }, + "output": { + "type": "structure", + "members": { + "vaultNotificationConfig": { + "shape": "Sr" + } + }, + "payload": "vaultNotificationConfig" + } + }, + "InitiateJob": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/jobs", + "responseCode": 202 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "jobParameters": { + "type": "structure", + "members": { + "Format": {}, + "Type": {}, + "ArchiveId": {}, + "Description": {}, + "SNSTopic": {}, + "RetrievalByteRange": {}, + "InventoryRetrievalParameters": { + "type": "structure", + "members": { + "StartDate": {}, + "EndDate": {}, + "Limit": {}, + "Marker": {} + } + } + } + } + }, + "required": [ + "accountId", + "vaultName" + ], + "payload": "jobParameters" + }, + "output": { + "type": "structure", + "members": { + "location": { + "location": "header", + "locationName": "Location" + }, + "jobId": { + "location": "header", + "locationName": "x-amz-job-id" + } + } + } + }, + "InitiateMultipartUpload": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "archiveDescription": { + "location": "header", + "locationName": "x-amz-archive-description" + }, + "partSize": { + "location": "header", + "locationName": "x-amz-part-size" + } + }, + "required": [ + "accountId", + "vaultName" + ] + }, + "output": { + "type": "structure", + "members": { + "location": { + "location": "header", + "locationName": "Location" + }, + "uploadId": { + "location": "header", + "locationName": "x-amz-multipart-upload-id" + } + } + } + }, + "ListJobs": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/jobs" + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "limit": { + "location": "querystring", + "locationName": "limit" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "statuscode": { + "location": "querystring", + "locationName": "statuscode" + }, + "completed": { + "location": "querystring", + "locationName": "completed" + } + }, + "required": [ + "accountId", + "vaultName" + ] + }, + "output": { + "type": "structure", + "members": { + "JobList": { + "type": "list", + "member": { + "shape": "Sb" + } + }, + "Marker": {} + } + } + }, + "ListMultipartUploads": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads" + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "limit": { + "location": "querystring", + "locationName": "limit" + } + }, + "required": [ + "accountId", + "vaultName" + ] + }, + "output": { + "type": "structure", + "members": { + "UploadsList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "MultipartUploadId": {}, + "VaultARN": {}, + "ArchiveDescription": {}, + "PartSizeInBytes": { + "type": "long" + }, + "CreationDate": {} + } + } + }, + "Marker": {} + } + } + }, + "ListParts": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}" + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "uploadId": { + "location": "uri", + "locationName": "uploadId" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "limit": { + "location": "querystring", + "locationName": "limit" + } + }, + "required": [ + "accountId", + "vaultName", + "uploadId" + ] + }, + "output": { + "type": "structure", + "members": { + "MultipartUploadId": {}, + "VaultARN": {}, + "ArchiveDescription": {}, + "PartSizeInBytes": { + "type": "long" + }, + "CreationDate": {}, + "Parts": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RangeInBytes": {}, + "SHA256TreeHash": {} + } + } + }, + "Marker": {} + } + } + }, + "ListVaults": { + "http": { + "method": "GET", + "requestUri": "/{accountId}/vaults" + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "marker": { + "location": "querystring", + "locationName": "marker" + }, + "limit": { + "location": "querystring", + "locationName": "limit" + } + }, + "required": [ + "accountId" + ] + }, + "output": { + "type": "structure", + "members": { + "VaultList": { + "type": "list", + "member": { + "shape": "Sj" + } + }, + "Marker": {} + } + } + }, + "SetVaultNotifications": { + "http": { + "method": "PUT", + "requestUri": "/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "vaultNotificationConfig": { + "shape": "Sr" + } + }, + "required": [ + "accountId", + "vaultName" + ], + "payload": "vaultNotificationConfig" + } + }, + "UploadArchive": { + "http": { + "requestUri": "/{accountId}/vaults/{vaultName}/archives", + "responseCode": 201 + }, + "input": { + "type": "structure", + "members": { + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "archiveDescription": { + "location": "header", + "locationName": "x-amz-archive-description" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "body": { + "shape": "Sn" + } + }, + "required": [ + "vaultName", + "accountId" + ], + "payload": "body" + }, + "output": { + "shape": "S4" + } + }, + "UploadMultipartPart": { + "http": { + "method": "PUT", + "requestUri": "/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "members": { + "accountId": { + "location": "uri", + "locationName": "accountId" + }, + "vaultName": { + "location": "uri", + "locationName": "vaultName" + }, + "uploadId": { + "location": "uri", + "locationName": "uploadId" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "range": { + "location": "header", + "locationName": "Content-Range" + }, + "body": { + "shape": "Sn" + } + }, + "required": [ + "accountId", + "vaultName", + "uploadId" + ], + "payload": "body" + }, + "output": { + "type": "structure", + "members": { + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "location": { + "location": "header", + "locationName": "Location" + }, + "checksum": { + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "archiveId": { + "location": "header", + "locationName": "x-amz-archive-id" + } + } + }, + "Sb": { + "type": "structure", + "members": { + "JobId": {}, + "JobDescription": {}, + "Action": {}, + "ArchiveId": {}, + "VaultARN": {}, + "CreationDate": {}, + "Completed": { + "type": "boolean" + }, + "StatusCode": {}, + "StatusMessage": {}, + "ArchiveSizeInBytes": { + "type": "long" + }, + "InventorySizeInBytes": { + "type": "long" + }, + "SNSTopic": {}, + "CompletionDate": {}, + "SHA256TreeHash": {}, + "ArchiveSHA256TreeHash": {}, + "RetrievalByteRange": {}, + "InventoryRetrievalParameters": { + "type": "structure", + "members": { + "Format": {}, + "StartDate": {}, + "EndDate": {}, + "Limit": {}, + "Marker": {} + } + } + } + }, + "Sj": { + "type": "structure", + "members": { + "VaultARN": {}, + "VaultName": {}, + "CreationDate": {}, + "LastInventoryDate": {}, + "NumberOfArchives": { + "type": "long" + }, + "SizeInBytes": { + "type": "long" + } + } + }, + "Sn": { + "type": "blob", + "streaming": true + }, + "Sr": { + "type": "structure", + "members": { + "SNSTopic": {}, + "Events": { + "type": "list", + "member": {} + } + } + } + } +} \ No newline at end of file diff --git a/apis/glacier-2012-06-01.full.json b/apis/glacier-2012-06-01.full.json new file mode 100644 index 0000000000..1eb7a43b87 --- /dev/null +++ b/apis/glacier-2012-06-01.full.json @@ -0,0 +1,2012 @@ +{ + "metadata":{ + "apiVersion":"2012-06-01", + "checksumFormat":"sha256", + "endpointPrefix":"glacier", + "serviceFullName":"Amazon Glacier", + "signatureVersion":"v4", + "protocol":"rest-json" + }, + "documentation":"

Amazon Glacier is a storage solution for \"cold data.\"

\n\n

Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and\n\t\teasy-to-use storage for data backup and archival. With Amazon Glacier, customers can store\n\t\ttheir data cost effectively for months, years, or decades. Amazon Glacier also enables\n\t\tcustomers to offload the administrative burdens of operating and scaling storage to AWS, so\n\t\tthey don't have to worry about capacity planning, hardware provisioning, data replication,\n\t\thardware failure and recovery, or time-consuming hardware migrations.

\n\n

Amazon Glacier is a great storage choice when low storage cost is paramount, your data is\n\t\trarely retrieved, and retrieval latency of several hours is acceptable. If your application\n\t\trequires fast or frequent access to your data, consider using Amazon S3. For more\n\t\tinformation, go to Amazon Simple Storage Service (Amazon S3).

\n\n

You can store any kind of data in any format. There is no maximum limit on the total amount\n\t\tof data you can store in Amazon Glacier.

\n\n

If you are a first-time user of Amazon Glacier, we recommend that you begin \n by reading the following sections in the Amazon Glacier Developer Guide:

\n ", + "operations":{ + "AbortMultipartUpload":{ + "name":"AbortMultipartUpload", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":204 + }, + "input":{ + "shape":"AbortMultipartUploadInput", + "documentation":"

Provides options to abort a multipart upload identified by the upload ID.

\n \n

For information about the underlying REST API, go to \n Abort Multipart Upload. \n For conceptual information, go to Working with Archives in Amazon Glacier.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation aborts a multipart upload identified by the upload ID.

\n \n\n\t\t

After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the\n\t\t\tmultipart upload or complete the multipart upload. Aborting a completed upload fails.\n\t\t\tHowever, aborting an already-aborted upload will succeed, for a short time. For more\n\t\t\tinformation about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.

\n\n\t\t

This operation is idempotent.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Working with Archives in Amazon Glacier \n and \n Abort Multipart Upload in the Amazon Glacier Developer Guide.\n

" + }, + "CompleteMultipartUpload":{ + "name":"CompleteMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":201 + }, + "input":{ + "shape":"CompleteMultipartUploadInput", + "documentation":"

Provides options to complete a multipart upload operation. \n This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble \n the archive from the uploaded parts. \n After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive \n resource.

" + }, + "output":{ + "shape":"ArchiveCreationOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

\n

For information about the underlying REST API, go to \n Upload Archive. \n For conceptual information, go to Working with Archives in Amazon Glacier.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

You call this operation to inform Amazon Glacier that all the archive parts have been uploaded\n\t\t\tand that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and\n\t\t\tsaving the archive to the vault, Amazon Glacier returns the URI path of the newly created\n\t\t\tarchive resource. Using the URI path, you can then access the archive. After you upload\n\t\t\tan archive, you should save the archive ID returned to retrieve the archive at a later\n\t\t\tpoint. You can also get the vault inventory to obtain a list of archive IDs in a vault.\n\t\t\tFor more information, see InitiateJob.

\n\n\t\t

In the request, you must include the computed SHA256 tree hash of the entire archive you\n\t\t\thave uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server\n\t\t\tside, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the\n\t\t\tvalues match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error,\n\t\t\tand the operation fails. The ListParts operation returns a list of parts uploaded for\n\t\t\ta specific multipart upload. It includes checksum information for each uploaded part\n\t\t\tthat can be used to debug a bad checksum issue.

\n \n\t\t

Additionally, Amazon Glacier also checks for any missing content ranges when assembling the\n\t\t\tarchive, if missing content ranges are found, Amazon Glacier returns an error and the\n\t\t\toperation fails.

\n\n\t\t

Complete Multipart Upload is an idempotent operation. After your first successful complete\n\t\t\tmultipart upload, if you call the operation again within a short period, the operation\n\t\t\twill succeed and return the same archive ID. This is useful in the event you experience\n\t\t\ta network issue that causes an aborted connection or receive a 500 server error, in\n\t\t\twhich case you can repeat your Complete Multipart Upload request and get the same\n\t\t\tarchive ID without creating duplicate archives. Note, however, that after the multipart\n\t\t\tupload completes, you cannot call the List Parts operation and the multipart upload will\n\t\t\tnot appear in List Multipart Uploads response, even if idempotent complete is\n\t\t\tpossible.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Uploading Large Archives in Parts (Multipart Upload) \n and \n Complete Multipart Upload in the Amazon Glacier Developer Guide.\n

" + }, + "CreateVault":{ + "name":"CreateVault", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}", + "responseCode":201 + }, + "input":{ + "shape":"CreateVaultInput", + "documentation":"

Provides options to create a vault.

" + }, + "output":{ + "shape":"CreateVaultOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if the request results in a vault or account limit being exceeded.

" + } + ], + "documentation":"

This operation creates a new vault with the specified name. The name of the vault must be\n\t\t\tunique within a region for an AWS account. You can create up to 1,000 vaults per\n\t\t\taccount. If you need to create more vaults, contact Amazon Glacier.

\n\t\t

You must use the following guidelines when naming a vault.

\n\t\t

\n\t\t\t

\n\t\t

\n\t\t\n

This operation is idempotent.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Creating a Vault in Amazon Glacier \n and \n Create Vault in the Amazon Glacier Developer Guide.\n

" + }, + "DeleteArchive":{ + "name":"DeleteArchive", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/archives/{archiveId}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteArchiveInput", + "documentation":"

Provides options for deleting an archive from an Amazon Glacier vault.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval\n\t\t\tof this archive will fail. Archive retrievals that are in progress for this archive ID\n\t\t\tmay or may not succeed according to the following scenarios:

\n\t \t\n\n\t\t

This operation is idempotent. Attempting to delete an already-deleted archive does not\n\t\t\tresult in an error.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Deleting an Archive in Amazon Glacier \n and \n Delete Archive in the Amazon Glacier Developer Guide.\n

" + }, + "DeleteVault":{ + "name":"DeleteVault", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteVaultInput", + "documentation":"

Provides options for deleting a vault from Amazon Glacier.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives\n\t\t\tin the vault as of the last inventory and there have been no writes to the vault since\n\t\t\tthe last inventory. If either of these conditions is not satisfied, the vault deletion\n\t\t\tfails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use\n\t\t\t\tDescribeVault to return the number of\n\t\t\tarchives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a\n\t\t\tvault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).

\n\n\t\t

This operation is idempotent.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Deleting a Vault in Amazon Glacier \n and \n Delete Vault in the Amazon Glacier Developer Guide.\n

" + }, + "DeleteVaultNotifications":{ + "name":"DeleteVaultNotifications", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode":204 + }, + "input":{ + "shape":"DeleteVaultNotificationsInput", + "documentation":"

Provides options for deleting a vault notification configuration from an Amazon Glacier vault.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation deletes the notification configuration set for a vault. The operation is\n\t\t\teventually consistent;that is, it might take some time for Amazon Glacier to\n\t\t\tcompletely disable the notifications and you might still receive some notifications for\n\t\t\ta short time after you send the delete request.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Configuring Vault Notifications in Amazon Glacier \n and \n Delete Vault Notification Configuration in the Amazon Glacier Developer Guide.\n

" + }, + "DescribeJob":{ + "name":"DescribeJob", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}" + }, + "input":{ + "shape":"DescribeJobInput", + "documentation":"

Provides options for retrieving a job description.

" + }, + "output":{ + "shape":"GlacierJobDescription", + "documentation":"

Describes an Amazon Glacier job.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation returns information about a job you previously initiated, including the job\n\t\t\tinitiation date, the user who initiated the job, the job status code/message and the\n\t\t\tAmazon SNS topic to notify after Amazon Glacier completes the job. For more information about\n\t\t\tinitiating a job, see InitiateJob.

\n\n\t\t

This operation enables you to check the status of your job. However, it is\n\t\t\t\t\tstrongly recommended that you set up an Amazon SNS topic and specify it in your\n\t\t\t\t\tinitiate job request so that Amazon Glacier can notify the topic after it completes\n\t\t\t\t\tthe job.

\n\n

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n \n

For information about the underlying REST API, go to \n Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide.\n

" + }, + "DescribeVault":{ + "name":"DescribeVault", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}" + }, + "input":{ + "shape":"DescribeVaultInput", + "documentation":"

Provides options for retrieving metadata for a specific vault in Amazon Glacier.

" + }, + "output":{ + "shape":"DescribeVaultOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation returns information about a vault, including the vault's Amazon Resource Name\n\t\t\t(ARN), the date the vault was created, the number of archives it contains, \n\t\t\tand the total size of all the archives in the vault. The number of archives and\n\t\t\ttheir total size are as of the last inventory generation. This means that if you add or\n\t\t\tremove an archive from a vault, and then immediately use Describe Vault, the change in\n\t\t\tcontents will not be immediately reflected. If you want to retrieve the latest inventory\n\t\t\tof the vault, use InitiateJob. Amazon Glacier generates vault inventories approximately daily. \n\t\t\tFor more information, see Downloading a Vault Inventory in Amazon Glacier.\n\t\t

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Retrieving Vault Metadata in Amazon Glacier \n and \n Describe Vault in the Amazon Glacier Developer Guide.\n

" + }, + "GetJobOutput":{ + "name":"GetJobOutput", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}/output" + }, + "input":{ + "shape":"GetJobOutputInput", + "documentation":"

Provides options for downloading output of an Amazon Glacier job.

" + }, + "output":{ + "shape":"GetJobOutputOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation downloads the output of the job you initiated using InitiateJob. Depending on the\n\t\t\tjob type you specified when you initiated the job, the output will be either the content\n\t\t\tof an archive or a vault inventory.

\n\n

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job\n\t\t\t\toutput within the 24 hours period after Amazon Glacier completes the job.

\n\n\t\t

If the job output is large, then you can use the Range request header to\n\t\t\tretrieve a portion of the output. This allows you to download the entire output in smaller\n\t\t\tchunks of bytes. For example, suppose you have 1 GB of job output you want to download and\n\t\t\tyou decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output\n\t\t\trequests. You use the following process to download the job output:

\n\n\t\t
    \n\t\t\t
  1. \n

    Download a 128 MB chunk of output by specifying the appropriate byte range using the\n\t\t\t\t\t\tRange header.

    \n\t\t\t
    2. \n\t\t\t
  2. \n

    Along with the data, the response includes a checksum of the payload. You compute\n\t\t\t\tthe checksum of the payload on the client and compare it with the checksum you received\n\t\t\t\tin the response to ensure you received all the expected data.

    \n\t\t\t
    3. \n\t\t\t
  3. \n

    Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time\n\t\t\t\tspecifying the appropriate byte range.

    \n\t\t\t
    4. \n\t\t\t
  4. \n

    After downloading all the parts of the job output, you have a list of eight checksum\n\t\t\t\tvalues. Compute the tree hash of these values to find the checksum of the entire output.\n\t\t\t\tUsing the DescribeJob API, obtain job information of the job that provided you the\n\t\t\t\toutput. The response includes the checksum of the entire archive stored in Amazon Glacier.\n\t\t\t\tYou compare this value with the checksum you computed to ensure you have downloaded the\n\t\t\t\tentire archive content with no errors.

    \n\t\t\t
    5. \n\t\t
\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and the underlying REST API, go to \n Downloading a Vault Inventory, \n Downloading an Archive, \n and \n Get Job Output

" + }, + "GetVaultNotifications":{ + "name":"GetVaultNotifications", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration" + }, + "input":{ + "shape":"GetVaultNotificationsInput", + "documentation":"

Provides options for retrieving the notification configuration set on an Amazon Glacier vault.

" + }, + "output":{ + "shape":"GetVaultNotificationsOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation retrieves the notification-configuration subresource of the\n\t\t\tspecified vault.

\n\n\t\t

For information about setting a notification configuration on a vault, see SetVaultNotifications. If\n\t\t\ta notification configuration for a vault is not set, the operation returns a 404 Not\n\t\t\t\tFound error. For more information about vault notifications, see Configuring Vault Notifications in Amazon Glacier.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Configuring Vault Notifications in Amazon Glacier \n and \n Get Vault Notification Configuration in the Amazon Glacier Developer Guide.\n

" + }, + "InitiateJob":{ + "name":"InitiateJob", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs", + "responseCode":202 + }, + "input":{ + "shape":"InitiateJobInput", + "documentation":"

Provides options for initiating an Amazon Glacier job.

" + }, + "output":{ + "shape":"InitiateJobOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation initiates a job of the specified type. In this release, you can initiate a\n\t\t\tjob to retrieve either an archive or a vault inventory (a list of archives in a vault).

\n\n\t\t

Retrieving data from Amazon Glacier is a two-step process:

\n\n\t\t
    \n\t\t\t

  1. Initiate a retrieval job.

    2. \n\t\t\t

  2. After the job completes, download the bytes.

    3. \n\t\t
\n\n\t\t

The retrieval request is executed asynchronously. When you initiate a retrieval job,\n\t\t\tAmazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes\n\t\t\tthe job, you can get the job output (archive or inventory data). For information about\n\t\t\tgetting job output, see GetJobOutput operation.

\n\n\t\t

The job must complete before you can get its output. To determine when a job is complete,\n\t\t\tyou have the following options:

\n\n\t\t\n\n\t\t

The information you get via notification is same that you get by calling DescribeJob.

\n\n\t\t

If for a specific event, you add both the notification configuration on the vault and also\n\t\t\tspecify an SNS topic in your initiate job request, Amazon Glacier sends both\n\t\t\tnotifications. For more information, see SetVaultNotifications.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n\n\t\t

About the Vault Inventory

\n\n\t\t

Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you\n\t\t\t\tinitiate a job for a vault inventory, Amazon Glacier returns the last inventory for\n\t\t\t\tthe vault. The inventory data you get might be up to a day or two days old. Also,\n\t\t\t\tthe initiate inventory job might take some time to complete before you can download\n\t\t\t\tthe vault inventory. So you do not want to retrieve a vault inventory for each vault\n\t\t\t\toperation. However, in some scenarios, you might find the vault inventory useful.\n\t\t\t\tFor example, when you upload an archive, you can provide an archive description but\n\t\t\t\tnot an archive name. Amazon Glacier provides you a unique archive ID, an opaque\n\t\t\t\tstring of characters. So, you might maintain your own database that maps archive\n\t\t\t\tnames to their corresponding Amazon Glacier assigned archive IDs. You might find the\n\t\t\t\tvault inventory useful in the event you need to reconcile information in your\n\t\t\t\tdatabase with the actual vault inventory.

\n \n

Range Inventory Retrieval

\n

You can limit the number of inventory items retrieved by filtering on the archive creation date \n or by setting a limit.

\n

Filtering by Archive Creation Date

\n

You can retrieve inventory items for archives created between StartDate and\n EndDate by specifying values for these parameters in the \n InitiateJob request. \n Archives created on or after the StartDate and before the EndDate will be returned. If\n you only provide the StartDate without the EndDate, you will retrieve the inventory for\n all archives created on or after the StartDate. If you only provide the EndDate\n without the StartDate, you will get back the inventory for all archives created\n before the EndDate.

\t\t\n \n

Limiting Inventory Items per Retrieval

\n

You can limit the number of inventory items returned by setting the Limit\n parameter in the InitiateJob request. The\n inventory job output will contain inventory items up to the specified\n Limit. If there are more inventory items available, the result\n is paginated. After a job is complete you can use the DescribeJob \n operation to get a marker that you use in a subsequent InitiateJob request. \n The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your\n entire inventory by repeatedly making InitiateJob requests with the marker from the previous \n DescribeJob output, until you get a marker from DescribeJob that returns null, indicating\n that there are no more inventory items available.

\t\t\t\t\t\t\n

You can use the Limit parameter together with the date range parameters.

\t \n \n

About Ranged Archive Retrieval

\n

\n You can initiate an archive retrieval for the whole archive or a range of the archive. \n In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. \n The range specified must be megabyte (MB) aligned, that is the range start value must be \n divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the \n archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a \n 400 response. Furthermore, to ensure you get checksum values for data you download using \n Get Job Output API, the range must be tree hash aligned. \n

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. \n\t\t You must grant them explicit permission to perform specific actions. For more information, \n\t\t see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and the underlying REST API, go to \n Initiate a Job\n and \n Downloading a Vault Inventory

" + }, + "InitiateMultipartUpload":{ + "name":"InitiateMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads", + "responseCode":201 + }, + "input":{ + "shape":"InitiateMultipartUploadInput", + "documentation":"

Provides options for initiating a multipart upload to an Amazon Glacier vault.

" + }, + "output":{ + "shape":"InitiateMultipartUploadOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource\n\t\t\tand returns its ID in the response. The multipart upload ID is used in subsequent\n\t\t\trequests to upload parts of an archive (see UploadMultipartPart).

\n\t\n\t

When you initiate a multipart upload, you specify the part size in number of bytes. The part\n\t\t\tsize must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576\n\t\t\t(1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable\n\t\t\tpart size is 1 MB, and the maximum is 4 GB.

\n\t\n\t\t

Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The\n\t\t\tlast one can be the same size or smaller. For example, suppose you want to upload a 16.2\n\t\t\tMB file. If you initiate the multipart upload with a part size of 4 MB, you will upload\n\t\t\tfour parts of 4 MB each and one part of 0.2 MB.

\n\n\t\t

You don't need to know the size of the archive when you start a multipart upload because\n\t\t\t\t\tAmazon Glacier does not require you to specify the overall archive size.

\n\n\t\t

After you complete the multipart upload, Amazon Glacier removes the multipart upload resource\n\t\t\treferenced by the ID. Amazon Glacier also removes the multipart upload resource if you\n\t\t\tcancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Uploading Large Archives in Parts (Multipart Upload) \n and \n Initiate Multipart Upload in the Amazon Glacier Developer Guide.

" + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs" + }, + "input":{ + "shape":"ListJobsInput", + "documentation":"

Provides options for retrieving a job list for an Amazon Glacier vault.

" + }, + "output":{ + "shape":"ListJobsOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have\n\t\t\trecently finished.

\n\n\t\t

Amazon Glacier retains recently completed jobs for a period before deleting them; however,\n\t\t\t\t\tit eventually removes completed jobs. The output of completed jobs can be\n\t\t\t\t\tretrieved. Retaining completed jobs for a period of time after they have\n\t\t\t\t\tcompleted enables you to get a job output in the event you miss the job\n\t\t\t\t\tcompletion notification or your first attempt to download it fails. For example,\n\t\t\t\t\tsuppose you start an archive retrieval job to download an archive. After the job\n\t\t\t\t\tcompletes, you start to download the archive but encounter a network error. In\n\t\t\t\t\tthis scenario, you can retry and download the archive while the job exists.

\n\t\t\n\t\t

To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate\n\t\t\ta job, and after the job completes, you download the data. For an archive retrieval, the\n\t\t\toutput is the archive data, and for an inventory retrieval, it is the inventory list.\n\t\t\tThe List Job operation returns a list of these jobs sorted by job initiation\n\t\t\ttime.

\n\n\t\t

This List Jobs operation supports pagination. \n\t\t By default, this operation returns up to 1,000 jobs in the response. \n\t\t You should always check the response for a marker at which to continue the list; \n\t\t if there are no more items the marker is null.\n To return a list of jobs that begins\n\t\t\tat a specific job, set the marker request parameter to the value you\n\t\t\tobtained from a previous List Jobs request. You can also limit the number of jobs\n\t\t\treturned in the response by specifying the limit parameter in the\n\t\t\trequest.

\n\n\t\t

Additionally, you can filter the jobs list returned by specifying an optional\n\t\t\t\tstatuscode (InProgress, Succeeded, or Failed) and\n\t\t\t\tcompleted (true, false) parameter. The statuscode allows\n\t\t\tyou to specify that only jobs that match a specified status are returned. The\n\t\t\t\tcompleted parameter allows you to specify that only jobs in a specific\n\t\t\tcompletion state are returned.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For the underlying REST API, go to \n List Jobs

" + }, + "ListMultipartUploads":{ + "name":"ListMultipartUploads", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads" + }, + "input":{ + "shape":"ListMultipartUploadsInput", + "documentation":"

Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.

" + }, + "output":{ + "shape":"ListMultipartUploadsOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation lists in-progress multipart uploads for the specified vault. An in-progress\n\t\t\tmultipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload\n\t\t\trequest, but has not yet been completed or aborted. The list returned in the List\n\t\t\tMultipart Upload response has no guaranteed order.\n\t

\n\n\t\t

The List Multipart Uploads operation supports pagination.\n\t\t By default, this operation returns up to 1,000 multipart uploads in the response. \n\t\t You should always check the response for a marker at which to continue the list; \n\t\t if there are no more items the marker is null. \n\t\t To return a list of multipart uploads that begins at a\n\t\t\tspecific upload, set the marker request parameter to the value you obtained\n\t\t\tfrom a previous List Multipart Upload request. You can also limit the number of uploads\n\t\t\treturned in the response by specifying the limit parameter in the\n\t\t\trequest.

\n\n\t\t

Note the difference between this operation and listing parts (ListParts). The List\n\t\t\tMultipart Uploads operation lists all multipart uploads for a vault and does not require\n\t\t\ta multipart upload ID. The List Parts operation requires a multipart upload ID since\n\t\t\tparts are associated with a single upload.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. \n\t\t You must grant them explicit permission to perform specific actions. \n\t\t For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n \n

For conceptual information and the underlying REST API, go to \n Working with Archives in Amazon Glacier \n and \n List Multipart Uploads in the Amazon Glacier Developer Guide.

" + }, + "ListParts":{ + "name":"ListParts", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}" + }, + "input":{ + "shape":"ListPartsInput", + "documentation":"

Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

" + }, + "output":{ + "shape":"ListPartsOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation lists the parts of an archive that have been uploaded in a specific multipart\n\t\t\tupload. You can make this request at any time during an in-progress multipart upload\n\t\t\tbefore you complete the upload (see CompleteMultipartUpload. List Parts returns an error for\n\t\t\tcompleted uploads. The list returned in the List Parts response is sorted by part range.\n\t\t

\n\n\t\t

The List Parts operation supports pagination. \n\t\t By default, this operation returns up to 1,000 uploaded parts in the response. \n\t\t You should always check the response for a marker at which to continue \n\t\t the list; if there are no more items the marker is null. \n\t\t To return a list of parts that\n\t\t\tbegins at a specific part, set the marker request parameter to the value\n\t\t\tyou obtained from a previous List Parts request. You can also limit the number of parts\n\t\t\treturned in the response by specifying the limit parameter in the request.\n\t\t

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. \n\t\t You must grant them explicit permission to perform specific actions. \n\t\t For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and the underlying REST API, go to \n Working with Archives in Amazon Glacier \n and \n List Parts in the Amazon Glacier Developer Guide.

" + }, + "ListVaults":{ + "name":"ListVaults", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults" + }, + "input":{ + "shape":"ListVaultsInput", + "documentation":"

Provides options to retrieve the vault list owned by the calling user's account. \n The list provides metadata information for each vault.

" + }, + "output":{ + "shape":"ListVaultsOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation lists all vaults owned by the calling user's account. The list returned in\n\t\t\tthe response is ASCII-sorted by vault name.

\n\n\t\t

By default, this operation returns up to 1,000 items. If there are more vaults to list, the\n\t\t\tresponse marker field contains the vault Amazon Resource Name (ARN) at\n\t\t\twhich to continue the list with a new List Vaults request; otherwise, the\n\t\t\t\tmarker field is null. To return a list of vaults that\n\t\t\tbegins at a specific vault, set the marker request parameter to the vault\n\t\t\tARN you obtained from a previous List Vaults request. You can also limit the number of\n\t\t\tvaults returned in the response by specifying the limit parameter in the\n\t\t\trequest.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Retrieving Vault Metadata in Amazon Glacier \n and \n List Vaults in the Amazon Glacier Developer Guide.\n

" + }, + "SetVaultNotifications":{ + "name":"SetVaultNotifications", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode":204 + }, + "input":{ + "shape":"SetVaultNotificationsInput", + "documentation":"

Provides options to configure notifications that will be sent when specific events happen to a vault.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation configures notifications that will be sent when specific events happen\n\t\t\tto a vault. By default, you don't get any notifications.

\n\n\t\t

To configure vault notifications, send a PUT request to the\n\t\t\t\tnotification-configuration subresource of the vault. The request should\n\t\t\tinclude a JSON document that provides an Amazon SNS topic and specific events for which\n\t\t\tyou want Amazon Glacier to send notifications to the topic.

\n\n\t\t

Amazon SNS topics must grant permission to the vault to be allowed to publish\n\t\t\tnotifications to the topic. You can configure a vault to publish a notification for the\n\t\t\tfollowing vault events:

\n\n\t\t\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Configuring Vault Notifications in Amazon Glacier \n and \n Set Vault Notification Configuration in the Amazon Glacier Developer Guide.\n

" + }, + "UploadArchive":{ + "name":"UploadArchive", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/archives", + "responseCode":201 + }, + "input":{ + "shape":"UploadArchiveInput", + "documentation":"

Provides options to add an archive to a vault.

" + }, + "output":{ + "shape":"ArchiveCreationOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

\n

For information about the underlying REST API, go to \n Upload Archive. \n For conceptual information, go to Working with Archives in Amazon Glacier.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"RequestTimeoutException", + "error":{"httpStatusCode":408}, + "exception":true, + "documentation":"

Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation adds an archive to a vault. This is a synchronous operation, and for a\n\t\t\tsuccessful upload, your data is durably persisted. Amazon Glacier returns the archive ID in\n\t\t\tthe x-amz-archive-id header of the response.\n\t\t

\n\n\t\t

You must use the archive ID to access your data in Amazon Glacier. After you upload an archive,\n\t\t\tyou should save the archive ID returned so that you can retrieve or delete the archive\n\t\t\tlater. Besides saving the archive ID, you can also index it and give it a friendly name\n\t\t\tto allow for better searching. You can also use the optional archive description field\n\t\t\tto specify how the archive is referred to in an external index of archives, such as you\n\t\t\tmight create in Amazon DynamoDB. You can also get the vault inventory to obtain a list\n\t\t\tof archive IDs in a vault. For more information, see InitiateJob. \n\t\t

\n\n\t\t

You must provide a SHA256 tree hash of the data you are uploading. For information about\n\t\t\tcomputing a SHA256 tree hash, see Computing Checksums.

\n\n\t\t

You can optionally specify an archive description of up to 1,024 printable ASCII characters.\n\t\t\tYou can get the archive description when you either retrieve the archive or get the vault\n\t\t\tinventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description\n\t\t\tin any way. An archive description does not need to be unique. You cannot use the\n\t\t\tdescription to retrieve or sort the archive list. \n\t\t

\n\n\t\t

Archives are immutable. After you upload an archive, you cannot edit the archive or its\n\t\t\tdescription.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Uploading an Archive in Amazon Glacier \n and \n Upload Archive in the Amazon Glacier Developer Guide.\n

" + }, + "UploadMultipartPart":{ + "name":"UploadMultipartPart", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":204 + }, + "input":{ + "shape":"UploadMultipartPartInput", + "documentation":"

Provides options to upload a part of an archive in a multipart upload operation.

" + }, + "output":{ + "shape":"UploadMultipartPartOutput", + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + { + "shape":"RequestTimeoutException", + "error":{"httpStatusCode":408}, + "exception":true, + "documentation":"

Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.

" + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

This operation uploads a part of an archive. You can upload archive parts in any order. You\n\t\t\tcan also upload them in parallel. You can upload up to 10,000 parts for a\n\t\t\tmultipart upload.

\n\n\t\t

Amazon Glacier rejects your upload part request if any of the following conditions is\n\t\t\ttrue:

\n\n\t\t\n\n\t\t

This operation is idempotent. If you upload the same part multiple times, the data included\n\t\t\tin the most recent request overwrites the previously uploaded data.

\n\n\t\t

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

\n

For conceptual information and underlying REST API, go to \n Uploading Large Archives in Parts (Multipart Upload) \n and \n Upload Part in the Amazon Glacier Developer Guide.

" + } + }, + "shapes":{ + "AbortMultipartUploadInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "uploadId":{ + "shape":"string", + "location":"uri", + "locationName":"uploadId", + "documentation":"

The upload ID of the multipart upload to delete.

" + } + }, + "documentation":"

Provides options to abort a multipart upload identified by the upload ID.

\n \n

For information about the underlying REST API, go to \n Abort Multipart Upload. \n For conceptual information, go to Working with Archives in Amazon Glacier.

", + "required":[ + "accountId", + "vaultName", + "uploadId" + ] + }, + "ActionCode":{ + "type":"string", + "enum":[ + "ArchiveRetrieval", + "InventoryRetrieval" + ] + }, + "ArchiveCreationOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"

The relative URI path of the newly added archive resource.

" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash", + "documentation":"

The checksum of the archive computed by Amazon Glacier.

" + }, + "archiveId":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-id", + "documentation":"

The ID of the archive. This value is also included as part of the location.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

\n

For information about the underlying REST API, go to \n Upload Archive. \n For conceptual information, go to Working with Archives in Amazon Glacier.

" + }, + "CompleteMultipartUploadInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "uploadId":{ + "shape":"string", + "location":"uri", + "locationName":"uploadId", + "documentation":"

The upload ID of the multipart upload.

" + }, + "archiveSize":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-size", + "documentation":"

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash", + "documentation":"

The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

" + } + }, + "documentation":"

Provides options to complete a multipart upload operation. \n This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble \n the archive from the uploaded parts. \n After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive \n resource.

", + "required":[ + "accountId", + "vaultName", + "uploadId" + ] + }, + "CreateVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + } + }, + "documentation":"

Provides options to create a vault.

", + "required":[ + "accountId", + "vaultName" + ] + }, + "CreateVaultOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"

The URI of the vault that was created.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "DateTime":{"type":"string"}, + "DeleteArchiveInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "archiveId":{ + "shape":"string", + "location":"uri", + "locationName":"archiveId", + "documentation":"

The ID of the archive to delete.

" + } + }, + "documentation":"

Provides options for deleting an archive from an Amazon Glacier vault.

", + "required":[ + "accountId", + "vaultName", + "archiveId" + ] + }, + "DeleteVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + } + }, + "documentation":"

Provides options for deleting a vault from Amazon Glacier.

", + "required":[ + "accountId", + "vaultName" + ] + }, + "DeleteVaultNotificationsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + } + }, + "documentation":"

Provides options for deleting a vault notification configuration from an Amazon Glacier vault.

", + "required":[ + "accountId", + "vaultName" + ] + }, + "DescribeJobInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "jobId":{ + "shape":"string", + "location":"uri", + "locationName":"jobId", + "documentation":"

The ID of the job to describe.

" + } + }, + "documentation":"

Provides options for retrieving a job description.

", + "required":[ + "accountId", + "vaultName", + "jobId" + ] + }, + "DescribeVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + } + }, + "documentation":"

Provides options for retrieving metadata for a specific vault in Amazon Glacier.

", + "required":[ + "accountId", + "vaultName" + ] + }, + "DescribeVaultOutput":{ + "type":"structure", + "members":{ + "VaultARN":{ + "shape":"string", + "documentation":"

The Amazon Resource Name (ARN) of the vault.

" + }, + "VaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".

" + }, + "LastInventoryDate":{ + "shape":"string", + "documentation":"

The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".

" + }, + "NumberOfArchives":{ + "shape":"long", + "documentation":"

The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.

" + }, + "SizeInBytes":{ + "shape":"long", + "documentation":"

Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "GetJobOutputInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "jobId":{ + "shape":"string", + "location":"uri", + "locationName":"jobId", + "documentation":"

The job ID whose data is downloaded.

" + }, + "range":{ + "shape":"string", + "location":"header", + "locationName":"Range", + "documentation":"

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, \n specify \"Range: bytes=0-1048575\". By default, this operation downloads the entire output.

" + } + }, + "documentation":"

Provides options for downloading output of an Amazon Glacier job.

", + "required":[ + "accountId", + "vaultName", + "jobId" + ] + }, + "GetJobOutputOutput":{ + "type":"structure", + "members":{ + "body":{ + "shape":"Stream", + "documentation":"

The job data, either archive data or inventory data.

" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash", + "documentation":"

\n The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:\n

\n

" + }, + "status":{ + "shape":"httpstatus", + "location":"statusCode", + "documentation":"

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

" + }, + "contentRange":{ + "shape":"string", + "location":"header", + "locationName":"Content-Range", + "documentation":"

The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned.\n For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

" + }, + "acceptRanges":{ + "shape":"string", + "location":"header", + "locationName":"Accept-Ranges", + "documentation":"

Indicates the range units accepted. For more information, go to \n RFC2616.

" + }, + "contentType":{ + "shape":"string", + "location":"header", + "locationName":"Content-Type", + "documentation":"

The Content-Type depends on whether the job output is an archive or a vault inventory. \n For archive data, the Content-Type is application/octet-stream. \n For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.\n

" + }, + "archiveDescription":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-description", + "documentation":"

The description of an archive.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

", + "payload":"body" + }, + "GetVaultNotificationsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + } + }, + "documentation":"

Provides options for retrieving the notification configuration set on an Amazon Glacier vault.

", + "required":[ + "accountId", + "vaultName" + ] + }, + "GetVaultNotificationsOutput":{ + "type":"structure", + "members":{ + "vaultNotificationConfig":{ + "shape":"VaultNotificationConfig", + "documentation":"

Returns the notification configuration set on the vault.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

", + "payload":"vaultNotificationConfig" + }, + "GlacierJobDescription":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"string", + "documentation":"

An opaque string that identifies an Amazon Glacier job.

" + }, + "JobDescription":{ + "shape":"string", + "documentation":"

The job description you provided when you initiated the job.

" + }, + "Action":{ + "shape":"ActionCode", + "documentation":"

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

" + }, + "ArchiveId":{ + "shape":"string", + "documentation":"

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

" + }, + "VaultARN":{ + "shape":"string", + "documentation":"

The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The UTC date when the job was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".

" + }, + "Completed":{ + "shape":"boolean", + "documentation":"

The job status. When a job is completed, you get the job's output.

" + }, + "StatusCode":{ + "shape":"StatusCode", + "documentation":"

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

" + }, + "StatusMessage":{ + "shape":"string", + "documentation":"

A friendly message that describes the job status.

" + }, + "ArchiveSizeInBytes":{ + "shape":"Size", + "documentation":"

For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

" + }, + "InventorySizeInBytes":{ + "shape":"Size", + "documentation":"

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

" + }, + "SNSTopic":{ + "shape":"string", + "documentation":"

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

" + }, + "CompletionDate":{ + "shape":"string", + "documentation":"

The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

" + }, + "SHA256TreeHash":{ + "shape":"string", + "documentation":"

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

\n

\n The SHA256 tree hash value for the requested range of an archive. \n If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field \n returns a value.

\n

\n For the specific case when the whole archive is retrieved, this value is the \n same as the ArchiveSHA256TreeHash value.

\n

\n This field is null in the following situations:\n

\n \n \n

" + }, + "ArchiveSHA256TreeHash":{ + "shape":"string", + "documentation":"

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.\n

" + }, + "RetrievalByteRange":{ + "shape":"string", + "documentation":"

The retrieved byte range for archive retrieval jobs in the form \"StartByteValue-EndByteValue\" \n If no range was specified in the archive retrieval, then the whole archive is retrieved and \n StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. \n For inventory retrieval jobs this field is null.

" + }, + "InventoryRetrievalParameters":{ + "shape":"InventoryRetrievalJobDescription", + "documentation":"

Parameters used for range inventory retrieval.

" + } + }, + "documentation":"

Describes an Amazon Glacier job.

" + }, + "InitiateJobInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "jobParameters":{ + "shape":"JobParameters", + "documentation":"

Provides options for specifying job information.

" + } + }, + "documentation":"

Provides options for initiating an Amazon Glacier job.

", + "required":[ + "accountId", + "vaultName" + ], + "payload":"jobParameters" + }, + "InitiateJobOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"

The relative URI path of the job.

" + }, + "jobId":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-job-id", + "documentation":"

The ID of the job.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "InitiateMultipartUploadInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "archiveDescription":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-description", + "documentation":"

The archive description that you are uploading in parts.

\n

The part size must be a megabyte (1024 KB) multiplied by a power of 2—for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

" + }, + "partSize":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-part-size", + "documentation":"

The size of each part except the last, in bytes. The last part can be smaller than this part size.

" + } + }, + "documentation":"

Provides options for initiating a multipart upload to an Amazon Glacier vault.

", + "required":[ + "accountId", + "vaultName" + ] + }, + "InitiateMultipartUploadOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"

The relative URI path of the multipart upload ID Amazon Glacier created.

" + }, + "uploadId":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-multipart-upload-id", + "documentation":"

The ID of the multipart upload. This value is also included as part of the location.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

400 Bad Request

" + }, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + "InventoryRetrievalJobDescription":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"string", + "documentation":"

The output format for the vault inventory list, which is set by the InitiateJob request \n when initiating a job to retrieve a vault inventory. Valid values are \"CSV\" and \"JSON\".

" + }, + "StartDate":{ + "shape":"DateTime", + "documentation":"

The start of the date range in UTC for vault inventory retrieval that includes archives created \n on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.

" + }, + "EndDate":{ + "shape":"DateTime", + "documentation":"

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date.\n A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.

" + }, + "Limit":{ + "shape":"string", + "documentation":"

Specifies the maximum number of inventory items returned per vault inventory retrieval request. \n This limit is set when initiating the job with the a InitiateJob request.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the vault inventory retrieval results. \n You use the marker in a new InitiateJob request to obtain additional inventory items. \n If there are no more inventory items, this value is null. For more information, see\n \n Range Inventory Retrieval.

" + } + }, + "documentation":"

Describes the options for a range inventory retrieval job.

" + }, + "InventoryRetrievalJobInput":{ + "type":"structure", + "members":{ + "StartDate":{ + "shape":"string", + "documentation":"

The start of the date range in UTC for vault inventory retrieval that includes archives created \n on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.

" + }, + "EndDate":{ + "shape":"string", + "documentation":"

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date.\n A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.

" + }, + "Limit":{ + "shape":"string", + "documentation":"

Specifies the maximum number of inventory items returned per vault inventory retrieval request.\n Valid values are greater than or equal to 1.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the vault inventory retrieval results. \n You use the marker in a new InitiateJob request to obtain additional inventory items. \n If there are no more inventory items, this value is null.

" + } + }, + "documentation":"

Provides options for specifying a range inventory retrieval job.

" + }, + "JobList":{ + "type":"list", + "member":{"shape":"GlacierJobDescription"} + }, + "JobParameters":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"string", + "documentation":"

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. \n If you are initiating an inventory job and do not specify a Format field, JSON is the default format.\n Valid values are \"CSV\" and \"JSON\".

" + }, + "Type":{ + "shape":"string", + "documentation":"

The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. \n Valid values are \"archive-retrieval\" and \"inventory-retrieval\".

" + }, + "ArchiveId":{ + "shape":"string", + "documentation":"

The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. \n An error occurs if you specify this request parameter for an inventory retrieval job request.

" + }, + "Description":{ + "shape":"string", + "documentation":"

The optional description for the job.\n The description must be less than or equal to 1,024 bytes. \n The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

" + }, + "SNSTopic":{ + "shape":"string", + "documentation":"

The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. \n The specified topic publishes the notification to its subscribers. The SNS topic must exist.

" + }, + "RetrievalByteRange":{ + "shape":"string", + "documentation":"

The byte range to retrieve for an archive retrieval. in the form \"StartByteValue-EndByteValue\" \n If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte \n (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue \n plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size \n value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.\n

\n

An error occurs if you specify this field for an inventory retrieval job request.

" + }, + "InventoryRetrievalParameters":{ + "shape":"InventoryRetrievalJobInput", + "documentation":"

Input parameters used for range inventory retrieval.

" + } + }, + "documentation":"

Provides options for defining a job.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

400 Bad Request

" + }, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if the request results in a vault or account limit being exceeded.

" + }, + "ListJobsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "limit":{ + "shape":"string", + "location":"querystring", + "locationName":"limit", + "documentation":"

Specifies that the response be limited to the specified number of items or fewer. \n If not specified, the List Jobs operation returns up to 1,000 jobs.

" + }, + "marker":{ + "shape":"string", + "location":"querystring", + "locationName":"marker", + "documentation":"

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. \n Get the marker value from a previous List Jobs response. \n You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

" + }, + "statuscode":{ + "shape":"string", + "location":"querystring", + "locationName":"statuscode", + "documentation":"

Specifies the type of job status to return. You can specify the following values: \"InProgress\", \"Succeeded\", or \"Failed\".

" + }, + "completed":{ + "shape":"string", + "location":"querystring", + "locationName":"completed", + "documentation":"

Specifies the state of the jobs to return. You can specify true or false.

" + } + }, + "documentation":"

Provides options for retrieving a job list for an Amazon Glacier vault.

", + "required":[ + "accountId", + "vaultName" + ] + }, + "ListJobsOutput":{ + "type":"structure", + "members":{ + "JobList":{ + "shape":"JobList", + "documentation":"

A list of job objects. Each job object contains metadata describing the job.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the results. \n You use this value in a new List Jobs request to obtain more jobs in the list. \n If there are no more jobs, this value is null.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "ListMultipartUploadsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "marker":{ + "shape":"string", + "location":"querystring", + "locationName":"marker", + "documentation":"

An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. \n Get the marker value from a previous List Uploads response. \n You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.

" + }, + "limit":{ + "shape":"string", + "location":"querystring", + "locationName":"limit", + "documentation":"

Specifies the maximum number of uploads returned in the response body. \n If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

" + } + }, + "documentation":"

Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.

", + "required":[ + "accountId", + "vaultName" + ] + }, + "ListMultipartUploadsOutput":{ + "type":"structure", + "members":{ + "UploadsList":{ + "shape":"UploadsList", + "documentation":"

A list of in-progress multipart uploads.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the results. \n You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. \n If there are no more uploads, this value is null.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "ListPartsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "uploadId":{ + "shape":"string", + "location":"uri", + "locationName":"uploadId", + "documentation":"

The upload ID of the multipart upload.

" + }, + "marker":{ + "shape":"string", + "location":"querystring", + "locationName":"marker", + "documentation":"

An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. \n Get the marker value from the response of a previous List Parts response. \n You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

" + }, + "limit":{ + "shape":"string", + "location":"querystring", + "locationName":"limit", + "documentation":"

Specifies the maximum number of parts returned in the response body. \n If this value is not specified, the List Parts operation returns up to 1,000 uploads.

" + } + }, + "documentation":"

Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

", + "required":[ + "accountId", + "vaultName", + "uploadId" + ] + }, + "ListPartsOutput":{ + "type":"structure", + "members":{ + "MultipartUploadId":{ + "shape":"string", + "documentation":"

The ID of the upload to which the parts are associated.

" + }, + "VaultARN":{ + "shape":"string", + "documentation":"

The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

" + }, + "ArchiveDescription":{ + "shape":"string", + "documentation":"

The description of the archive that was specified in the Initiate Multipart Upload request.

" + }, + "PartSizeInBytes":{ + "shape":"long", + "documentation":"

The part size in bytes.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The UTC time at which the multipart upload was initiated.

" + }, + "Parts":{ + "shape":"PartList", + "documentation":"

A list of the part sizes of the multipart upload.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the results. \n You use the marker in a new List Parts request to obtain more jobs in the list. \n If there are no more parts, this value is null.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "ListVaultsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "marker":{ + "shape":"string", + "location":"querystring", + "locationName":"marker", + "documentation":"

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

" + }, + "limit":{ + "shape":"string", + "location":"querystring", + "locationName":"limit", + "documentation":"

The maximum number of items returned in the response. \n If you don't specify a value, the List Vaults operation returns up to 1,000 items.

" + } + }, + "documentation":"

Provides options to retrieve the vault list owned by the calling user's account. \n The list provides metadata information for each vault.

", + "required":["accountId"] + }, + "ListVaultsOutput":{ + "type":"structure", + "members":{ + "VaultList":{ + "shape":"VaultList", + "documentation":"

List of vaults.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

The vault ARN at which to continue pagination of the results. \n You use the marker in another List Vaults request to obtain more vaults in the list.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "MissingParameterValueException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client.

" + }, + "code":{ + "shape":"string", + "documentation":"

400 Bad Request

" + }, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Returned if a required header or parameter is missing from the request.

" + }, + "NotificationEventList":{ + "type":"list", + "member":{"shape":"string"} + }, + "PartList":{ + "type":"list", + "member":{"shape":"PartListElement"} + }, + "PartListElement":{ + "type":"structure", + "members":{ + "RangeInBytes":{ + "shape":"string", + "documentation":"

The byte range of a part, inclusive of the upper value of the range.

" + }, + "SHA256TreeHash":{ + "shape":"string", + "documentation":"

The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null.

" + } + }, + "documentation":"

A list of the part sizes of the multipart upload.

" + }, + "RequestTimeoutException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

408 Request Timeout

" + }, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":408}, + "exception":true, + "documentation":"

Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

404 Not Found

" + }, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Server

" + }, + "code":{ + "shape":"string", + "documentation":"

500 Internal Server Error

" + }, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

Returned if the service cannot complete the request.

" + }, + "SetVaultNotificationsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "vaultNotificationConfig":{ + "shape":"VaultNotificationConfig", + "documentation":"

Provides options for specifying notification configuration.

" + } + }, + "documentation":"

Provides options to configure notifications that will be sent when specific events happen to a vault.

", + "required":[ + "accountId", + "vaultName" + ], + "payload":"vaultNotificationConfig" + }, + "Size":{"type":"long"}, + "StatusCode":{ + "type":"string", + "enum":[ + "InProgress", + "Succeeded", + "Failed" + ] + }, + "Stream":{ + "type":"blob", + "streaming":true + }, + "UploadArchiveInput":{ + "type":"structure", + "members":{ + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "archiveDescription":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-description", + "documentation":"

The optional description of the archive you are uploading.

" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash", + "documentation":"

The SHA256 checksum (a linear hash) of the payload.

" + }, + "body":{ + "shape":"Stream", + "documentation":"

The data to upload.

" + } + }, + "documentation":"

Provides options to add an archive to a vault.

", + "required":[ + "vaultName", + "accountId" + ], + "payload":"body" + }, + "UploadListElement":{ + "type":"structure", + "members":{ + "MultipartUploadId":{ + "shape":"string", + "documentation":"

The ID of a multipart upload.

" + }, + "VaultARN":{ + "shape":"string", + "documentation":"

The Amazon Resource Name (ARN) of the vault that contains the archive.

" + }, + "ArchiveDescription":{ + "shape":"string", + "documentation":"

The description of the archive that was specified in the Initiate Multipart Upload request.

" + }, + "PartSizeInBytes":{ + "shape":"long", + "documentation":"

The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The UTC time at which the multipart upload was initiated.

" + } + }, + "documentation":"

A list of in-progress multipart uploads for a vault.

" + }, + "UploadMultipartPartInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId", + "documentation":"

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', \n in which case Amazon Glacier uses the AWS Account ID associated with the credentials used \n to sign the request. If you specify your Account ID, do not include hyphens in it.

" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName", + "documentation":"

The name of the vault.

" + }, + "uploadId":{ + "shape":"string", + "location":"uri", + "locationName":"uploadId", + "documentation":"

The upload ID of the multipart upload.

" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash", + "documentation":"

The SHA256 tree hash of the data being uploaded.

" + }, + "range":{ + "shape":"string", + "location":"header", + "locationName":"Content-Range", + "documentation":"

Identifies the range of bytes in the assembled archive that will be uploaded in this part. \n Amazon Glacier uses this information to assemble the archive in the proper sequence. \n The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

" + }, + "body":{ + "shape":"Stream", + "documentation":"

The data to upload.

" + } + }, + "documentation":"

Provides options to upload a part of an archive in a multipart upload operation.

", + "required":[ + "accountId", + "vaultName", + "uploadId" + ], + "payload":"body" + }, + "UploadMultipartPartOutput":{ + "type":"structure", + "members":{ + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash", + "documentation":"

The SHA256 tree hash that Amazon Glacier computed for the uploaded part.

" + } + }, + "documentation":"

Contains the Amazon Glacier response to your request.

" + }, + "UploadsList":{ + "type":"list", + "member":{"shape":"UploadListElement"} + }, + "VaultList":{ + "type":"list", + "member":{"shape":"DescribeVaultOutput"} + }, + "VaultNotificationConfig":{ + "type":"structure", + "members":{ + "SNSTopic":{ + "shape":"string", + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

" + }, + "Events":{ + "shape":"NotificationEventList", + "documentation":"

A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

" + } + }, + "documentation":"

Represents a vault's notification configuration.

" + }, + "boolean":{"type":"boolean"}, + "httpstatus":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"} + } +} diff --git a/apis/glacier-2012-06-01.paginators.json b/apis/glacier-2012-06-01.paginators.json new file mode 100644 index 0000000000..69691437eb --- /dev/null +++ b/apis/glacier-2012-06-01.paginators.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListJobs": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "JobList" + }, + "ListMultipartUploads": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "UploadsList" + }, + "ListParts": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "Parts" + }, + "ListVaults": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "VaultList" + } + } +} diff --git a/apis/glacier-2012-06-01.waiters.json b/apis/glacier-2012-06-01.waiters.json new file mode 100644 index 0000000000..170c2c76d1 --- /dev/null +++ b/apis/glacier-2012-06-01.waiters.json @@ -0,0 +1,23 @@ +{ + "waiters": { + "__default__": { + "interval": 3, + "max_attempts": 15 + }, + "__VaultState": { + "operation": "DescribeVault" + }, + "VaultExists": { + "extends": "__VaultState", + "ignore_errors": [ + "ResourceNotFoundException" + ], + "success_type": "output" + }, + "VaultNotExists": { + "extends": "__VaultState", + "success_type": "error", + "success_value": "ResourceNotFoundException" + } + } +} diff --git a/apis/iam-2010-05-08.api.json b/apis/iam-2010-05-08.api.json new file mode 100644 index 0000000000..9570d16ee0 --- /dev/null +++ b/apis/iam-2010-05-08.api.json @@ -0,0 +1,1801 @@ +{ + "metadata": { + "apiVersion": "2010-05-08", + "endpointPrefix": "iam", + "globalEndpoint": "iam.amazonaws.com", + "serviceAbbreviation": "IAM", + "serviceFullName": "AWS Identity and Access Management", + "signatureVersion": "v4", + "xmlNamespace": "https://iam.amazonaws.com/doc/2010-05-08/", + "protocol": "query" + }, + "operations": { + "AddRoleToInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName", + "RoleName" + ], + "members": { + "InstanceProfileName": {}, + "RoleName": {} + } + } + }, + "AddUserToGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "UserName" + ], + "members": { + "GroupName": {}, + "UserName": {} + } + } + }, + "ChangePassword": { + "input": { + "type": "structure", + "required": [ + "OldPassword", + "NewPassword" + ], + "members": { + "OldPassword": { + "shape": "S8" + }, + "NewPassword": { + "shape": "S8" + } + } + } + }, + "CreateAccessKey": { + "input": { + "type": "structure", + "members": { + "UserName": {} + } + }, + "output": { + "resultWrapper": "CreateAccessKeyResult", + "type": "structure", + "required": [ + "AccessKey" + ], + "members": { + "AccessKey": { + "type": "structure", + "required": [ + "UserName", + "AccessKeyId", + "Status", + "SecretAccessKey" + ], + "members": { + "UserName": {}, + "AccessKeyId": {}, + "Status": {}, + "SecretAccessKey": { + "type": "string", + "sensitive": true + }, + "CreateDate": { + "type": "timestamp" + } + } + } + } + } + }, + "CreateAccountAlias": { + "input": { + "type": "structure", + "required": [ + "AccountAlias" + ], + "members": { + "AccountAlias": {} + } + } + }, + "CreateGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "Path": {}, + "GroupName": {} + } + }, + "output": { + "resultWrapper": "CreateGroupResult", + "type": "structure", + "required": [ + "Group" + ], + "members": { + "Group": { + "shape": "Sm" + } + } + } + }, + "CreateInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName" + ], + "members": { + "InstanceProfileName": {}, + "Path": {} + } + }, + "output": { + "resultWrapper": "CreateInstanceProfileResult", + "type": "structure", + "required": [ + "InstanceProfile" + ], + "members": { + "InstanceProfile": { + "shape": "Sr" + } + } + } + }, + "CreateLoginProfile": { + "input": { + "type": "structure", + "required": [ + "UserName", + "Password" + ], + "members": { + "UserName": {}, + "Password": { + "shape": "S8" + }, + "PasswordResetRequired": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateLoginProfileResult", + "type": "structure", + "required": [ + "LoginProfile" + ], + "members": { + "LoginProfile": { + "shape": "Sy" + } + } + } + }, + "CreateRole": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "AssumeRolePolicyDocument" + ], + "members": { + "Path": {}, + "RoleName": {}, + "AssumeRolePolicyDocument": {} + } + }, + "output": { + "resultWrapper": "CreateRoleResult", + "type": "structure", + "required": [ + "Role" + ], + "members": { + "Role": { + "shape": "St" + } + } + } + }, + "CreateSAMLProvider": { + "input": { + "type": "structure", + "required": [ + "SAMLMetadataDocument", + "Name" + ], + "members": { + "SAMLMetadataDocument": {}, + "Name": {} + } + }, + "output": { + "resultWrapper": "CreateSAMLProviderResult", + "type": "structure", + "members": { + "SAMLProviderArn": {} + } + } + }, + "CreateUser": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "Path": {}, + "UserName": {} + } + }, + "output": { + "resultWrapper": "CreateUserResult", + "type": "structure", + "members": { + "User": { + "shape": "S17" + } + } + } + }, + "CreateVirtualMFADevice": { + "input": { + "type": "structure", + "required": [ + "VirtualMFADeviceName" + ], + "members": { + "Path": {}, + "VirtualMFADeviceName": {} + } + }, + "output": { + "resultWrapper": "CreateVirtualMFADeviceResult", + "type": "structure", + "required": [ + "VirtualMFADevice" + ], + "members": { + "VirtualMFADevice": { + "shape": "S1b" + } + } + } + }, + "DeactivateMFADevice": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SerialNumber" + ], + "members": { + "UserName": {}, + "SerialNumber": {} + } + } + }, + "DeleteAccessKey": { + "input": { + "type": "structure", + "required": [ + "AccessKeyId" + ], + "members": { + "UserName": {}, + "AccessKeyId": {} + } + } + }, + "DeleteAccountAlias": { + "input": { + "type": "structure", + "required": [ + "AccountAlias" + ], + "members": { + "AccountAlias": {} + } + } + }, + "DeleteAccountPasswordPolicy": {}, + "DeleteGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {} + } + } + }, + "DeleteGroupPolicy": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "PolicyName" + ], + "members": { + "GroupName": {}, + "PolicyName": {} + } + } + }, + "DeleteInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName" + ], + "members": { + "InstanceProfileName": {} + } + } + }, + "DeleteLoginProfile": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {} + } + } + }, + "DeleteRole": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {} + } + } + }, + "DeleteRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyName" + ], + "members": { + "RoleName": {}, + "PolicyName": {} + } + } + }, + "DeleteSAMLProvider": { + "input": { + "type": "structure", + "required": [ + "SAMLProviderArn" + ], + "members": { + "SAMLProviderArn": {} + } + } + }, + "DeleteServerCertificate": { + "input": { + "type": "structure", + "required": [ + "ServerCertificateName" + ], + "members": { + "ServerCertificateName": {} + } + } + }, + "DeleteSigningCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateId" + ], + "members": { + "UserName": {}, + "CertificateId": {} + } + } + }, + "DeleteUser": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {} + } + } + }, + "DeleteUserPolicy": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PolicyName" + ], + "members": { + "UserName": {}, + "PolicyName": {} + } + } + }, + "DeleteVirtualMFADevice": { + "input": { + "type": "structure", + "required": [ + "SerialNumber" + ], + "members": { + "SerialNumber": {} + } + } + }, + "EnableMFADevice": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members": { + "UserName": {}, + "SerialNumber": {}, + "AuthenticationCode1": {}, + "AuthenticationCode2": {} + } + } + }, + "GenerateCredentialReport": { + "output": { + "resultWrapper": "GenerateCredentialReportResult", + "type": "structure", + "members": { + "State": {}, + "Description": {} + } + } + }, + "GetAccountPasswordPolicy": { + "output": { + "resultWrapper": "GetAccountPasswordPolicyResult", + "type": "structure", + "required": [ + "PasswordPolicy" + ], + "members": { + "PasswordPolicy": { + "type": "structure", + "members": { + "MinimumPasswordLength": { + "type": "integer" + }, + "RequireSymbols": { + "type": "boolean" + }, + "RequireNumbers": { + "type": "boolean" + }, + "RequireUppercaseCharacters": { + "type": "boolean" + }, + "RequireLowercaseCharacters": { + "type": "boolean" + }, + "AllowUsersToChangePassword": { + "type": "boolean" + }, + "ExpirePasswords": { + "type": "boolean" + }, + "MaxPasswordAge": { + "type": "integer" + }, + "PasswordReusePrevention": { + "type": "integer" + }, + "HardExpiry": { + "type": "boolean" + } + } + } + } + } + }, + "GetAccountSummary": { + "output": { + "resultWrapper": "GetAccountSummaryResult", + "type": "structure", + "members": { + "SummaryMap": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + } + } + } + }, + "GetCredentialReport": { + "output": { + "resultWrapper": "GetCredentialReportResult", + "type": "structure", + "members": { + "Content": { + "type": "blob" + }, + "ReportFormat": {}, + "GeneratedTime": { + "type": "timestamp" + } + } + } + }, + "GetGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "GetGroupResult", + "type": "structure", + "required": [ + "Group", + "Users" + ], + "members": { + "Group": { + "shape": "Sm" + }, + "Users": { + "shape": "S2i" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "GetGroupPolicy": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "PolicyName" + ], + "members": { + "GroupName": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "GetGroupPolicyResult", + "type": "structure", + "required": [ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "GroupName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "GetInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName" + ], + "members": { + "InstanceProfileName": {} + } + }, + "output": { + "resultWrapper": "GetInstanceProfileResult", + "type": "structure", + "required": [ + "InstanceProfile" + ], + "members": { + "InstanceProfile": { + "shape": "Sr" + } + } + } + }, + "GetLoginProfile": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {} + } + }, + "output": { + "resultWrapper": "GetLoginProfileResult", + "type": "structure", + "required": [ + "LoginProfile" + ], + "members": { + "LoginProfile": { + "shape": "Sy" + } + } + } + }, + "GetRole": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {} + } + }, + "output": { + "resultWrapper": "GetRoleResult", + "type": "structure", + "required": [ + "Role" + ], + "members": { + "Role": { + "shape": "St" + } + } + } + }, + "GetRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyName" + ], + "members": { + "RoleName": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "GetRolePolicyResult", + "type": "structure", + "required": [ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "RoleName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "GetSAMLProvider": { + "input": { + "type": "structure", + "required": [ + "SAMLProviderArn" + ], + "members": { + "SAMLProviderArn": {} + } + }, + "output": { + "resultWrapper": "GetSAMLProviderResult", + "type": "structure", + "members": { + "SAMLMetadataDocument": {}, + "CreateDate": { + "type": "timestamp" + }, + "ValidUntil": { + "type": "timestamp" + } + } + } + }, + "GetServerCertificate": { + "input": { + "type": "structure", + "required": [ + "ServerCertificateName" + ], + "members": { + "ServerCertificateName": {} + } + }, + "output": { + "resultWrapper": "GetServerCertificateResult", + "type": "structure", + "required": [ + "ServerCertificate" + ], + "members": { + "ServerCertificate": { + "type": "structure", + "required": [ + "ServerCertificateMetadata", + "CertificateBody" + ], + "members": { + "ServerCertificateMetadata": { + "shape": "S2y" + }, + "CertificateBody": {}, + "CertificateChain": {} + } + } + } + } + }, + "GetUser": { + "input": { + "type": "structure", + "members": { + "UserName": {} + } + }, + "output": { + "resultWrapper": "GetUserResult", + "type": "structure", + "required": [ + "User" + ], + "members": { + "User": { + "shape": "S17" + } + } + } + }, + "GetUserPolicy": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PolicyName" + ], + "members": { + "UserName": {}, + "PolicyName": {} + } + }, + "output": { + "resultWrapper": "GetUserPolicyResult", + "type": "structure", + "required": [ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "UserName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "ListAccessKeys": { + "input": { + "type": "structure", + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListAccessKeysResult", + "type": "structure", + "required": [ + "AccessKeyMetadata" + ], + "members": { + "AccessKeyMetadata": { + "type": "list", + "member": { + "type": "structure", + "members": { + "UserName": {}, + "AccessKeyId": {}, + "Status": {}, + "CreateDate": { + "type": "timestamp" + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListAccountAliases": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListAccountAliasesResult", + "type": "structure", + "required": [ + "AccountAliases" + ], + "members": { + "AccountAliases": { + "type": "list", + "member": {} + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListGroupPolicies": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListGroupPoliciesResult", + "type": "structure", + "required": [ + "PolicyNames" + ], + "members": { + "PolicyNames": { + "shape": "S3e" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListGroups": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListGroupsResult", + "type": "structure", + "required": [ + "Groups" + ], + "members": { + "Groups": { + "shape": "S3i" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListGroupsForUser": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListGroupsForUserResult", + "type": "structure", + "required": [ + "Groups" + ], + "members": { + "Groups": { + "shape": "S3i" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListInstanceProfiles": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListInstanceProfilesResult", + "type": "structure", + "required": [ + "InstanceProfiles" + ], + "members": { + "InstanceProfiles": { + "shape": "S3n" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListInstanceProfilesForRole": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListInstanceProfilesForRoleResult", + "type": "structure", + "required": [ + "InstanceProfiles" + ], + "members": { + "InstanceProfiles": { + "shape": "S3n" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListMFADevices": { + "input": { + "type": "structure", + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListMFADevicesResult", + "type": "structure", + "required": [ + "MFADevices" + ], + "members": { + "MFADevices": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "UserName", + "SerialNumber", + "EnableDate" + ], + "members": { + "UserName": {}, + "SerialNumber": {}, + "EnableDate": { + "type": "timestamp" + } + } + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListRolePolicies": { + "input": { + "type": "structure", + "required": [ + "RoleName" + ], + "members": { + "RoleName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListRolePoliciesResult", + "type": "structure", + "required": [ + "PolicyNames" + ], + "members": { + "PolicyNames": { + "shape": "S3e" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListRoles": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListRolesResult", + "type": "structure", + "required": [ + "Roles" + ], + "members": { + "Roles": { + "shape": "Ss" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListSAMLProviders": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "resultWrapper": "ListSAMLProvidersResult", + "type": "structure", + "members": { + "SAMLProviderList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "ValidUntil": { + "type": "timestamp" + }, + "CreateDate": { + "type": "timestamp" + } + } + } + } + } + } + }, + "ListServerCertificates": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListServerCertificatesResult", + "type": "structure", + "required": [ + "ServerCertificateMetadataList" + ], + "members": { + "ServerCertificateMetadataList": { + "type": "list", + "member": { + "shape": "S2y" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListSigningCertificates": { + "input": { + "type": "structure", + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListSigningCertificatesResult", + "type": "structure", + "required": [ + "Certificates" + ], + "members": { + "Certificates": { + "type": "list", + "member": { + "shape": "S48" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListUserPolicies": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListUserPoliciesResult", + "type": "structure", + "required": [ + "PolicyNames" + ], + "members": { + "PolicyNames": { + "shape": "S3e" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListUsers": { + "input": { + "type": "structure", + "members": { + "PathPrefix": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListUsersResult", + "type": "structure", + "required": [ + "Users" + ], + "members": { + "Users": { + "shape": "S2i" + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "ListVirtualMFADevices": { + "input": { + "type": "structure", + "members": { + "AssignmentStatus": {}, + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ListVirtualMFADevicesResult", + "type": "structure", + "required": [ + "VirtualMFADevices" + ], + "members": { + "VirtualMFADevices": { + "type": "list", + "member": { + "shape": "S1b" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "Marker": {} + } + } + }, + "PutGroupPolicy": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "GroupName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "PutRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "RoleName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "PutUserPolicy": { + "input": { + "type": "structure", + "required": [ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members": { + "UserName": {}, + "PolicyName": {}, + "PolicyDocument": {} + } + } + }, + "RemoveRoleFromInstanceProfile": { + "input": { + "type": "structure", + "required": [ + "InstanceProfileName", + "RoleName" + ], + "members": { + "InstanceProfileName": {}, + "RoleName": {} + } + } + }, + "RemoveUserFromGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName", + "UserName" + ], + "members": { + "GroupName": {}, + "UserName": {} + } + } + }, + "ResyncMFADevice": { + "input": { + "type": "structure", + "required": [ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members": { + "UserName": {}, + "SerialNumber": {}, + "AuthenticationCode1": {}, + "AuthenticationCode2": {} + } + } + }, + "UpdateAccessKey": { + "input": { + "type": "structure", + "required": [ + "AccessKeyId", + "Status" + ], + "members": { + "UserName": {}, + "AccessKeyId": {}, + "Status": {} + } + } + }, + "UpdateAccountPasswordPolicy": { + "input": { + "type": "structure", + "members": { + "MinimumPasswordLength": { + "type": "integer" + }, + "RequireSymbols": { + "type": "boolean" + }, + "RequireNumbers": { + "type": "boolean" + }, + "RequireUppercaseCharacters": { + "type": "boolean" + }, + "RequireLowercaseCharacters": { + "type": "boolean" + }, + "AllowUsersToChangePassword": { + "type": "boolean" + }, + "MaxPasswordAge": { + "type": "integer" + }, + "PasswordReusePrevention": { + "type": "integer" + }, + "HardExpiry": { + "type": "boolean" + } + } + } + }, + "UpdateAssumeRolePolicy": { + "input": { + "type": "structure", + "required": [ + "RoleName", + "PolicyDocument" + ], + "members": { + "RoleName": {}, + "PolicyDocument": {} + } + } + }, + "UpdateGroup": { + "input": { + "type": "structure", + "required": [ + "GroupName" + ], + "members": { + "GroupName": {}, + "NewPath": {}, + "NewGroupName": {} + } + } + }, + "UpdateLoginProfile": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "Password": { + "shape": "S8" + }, + "PasswordResetRequired": { + "type": "boolean" + } + } + } + }, + "UpdateSAMLProvider": { + "input": { + "type": "structure", + "required": [ + "SAMLMetadataDocument", + "SAMLProviderArn" + ], + "members": { + "SAMLMetadataDocument": {}, + "SAMLProviderArn": {} + } + }, + "output": { + "resultWrapper": "UpdateSAMLProviderResult", + "type": "structure", + "members": { + "SAMLProviderArn": {} + } + } + }, + "UpdateServerCertificate": { + "input": { + "type": "structure", + "required": [ + "ServerCertificateName" + ], + "members": { + "ServerCertificateName": {}, + "NewPath": {}, + "NewServerCertificateName": {} + } + } + }, + "UpdateSigningCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateId", + "Status" + ], + "members": { + "UserName": {}, + "CertificateId": {}, + "Status": {} + } + } + }, + "UpdateUser": { + "input": { + "type": "structure", + "required": [ + "UserName" + ], + "members": { + "UserName": {}, + "NewPath": {}, + "NewUserName": {} + } + } + }, + "UploadServerCertificate": { + "input": { + "type": "structure", + "required": [ + "ServerCertificateName", + "CertificateBody", + "PrivateKey" + ], + "members": { + "Path": {}, + "ServerCertificateName": {}, + "CertificateBody": {}, + "PrivateKey": { + "type": "string", + "sensitive": true + }, + "CertificateChain": {} + } + }, + "output": { + "resultWrapper": "UploadServerCertificateResult", + "type": "structure", + "members": { + "ServerCertificateMetadata": { + "shape": "S2y" + } + } + } + }, + "UploadSigningCertificate": { + "input": { + "type": "structure", + "required": [ + "CertificateBody" + ], + "members": { + "UserName": {}, + "CertificateBody": {} + } + }, + "output": { + "resultWrapper": "UploadSigningCertificateResult", + "type": "structure", + "required": [ + "Certificate" + ], + "members": { + "Certificate": { + "shape": "S48" + } + } + } + } + }, + "shapes": { + "S8": { + "type": "string", + "sensitive": true + }, + "Sm": { + "type": "structure", + "required": [ + "Path", + "GroupName", + "GroupId", + "Arn", + "CreateDate" + ], + "members": { + "Path": {}, + "GroupName": {}, + "GroupId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + } + } + }, + "Sr": { + "type": "structure", + "required": [ + "Path", + "InstanceProfileName", + "InstanceProfileId", + "Arn", + "CreateDate", + "Roles" + ], + "members": { + "Path": {}, + "InstanceProfileName": {}, + "InstanceProfileId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + }, + "Roles": { + "shape": "Ss" + } + } + }, + "Ss": { + "type": "list", + "member": { + "shape": "St" + } + }, + "St": { + "type": "structure", + "required": [ + "Path", + "RoleName", + "RoleId", + "Arn", + "CreateDate" + ], + "members": { + "Path": {}, + "RoleName": {}, + "RoleId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + }, + "AssumeRolePolicyDocument": {} + } + }, + "Sy": { + "type": "structure", + "required": [ + "UserName", + "CreateDate" + ], + "members": { + "UserName": {}, + "CreateDate": { + "type": "timestamp" + }, + "PasswordResetRequired": { + "type": "boolean" + } + } + }, + "S17": { + "type": "structure", + "required": [ + "Path", + "UserName", + "UserId", + "Arn", + "CreateDate" + ], + "members": { + "Path": {}, + "UserName": {}, + "UserId": {}, + "Arn": {}, + "CreateDate": { + "type": "timestamp" + } + } + }, + "S1b": { + "type": "structure", + "required": [ + "SerialNumber" + ], + "members": { + "SerialNumber": {}, + "Base32StringSeed": { + "shape": "S1d" + }, + "QRCodePNG": { + "shape": "S1d" + }, + "User": { + "shape": "S17" + }, + "EnableDate": { + "type": "timestamp" + } + } + }, + "S1d": { + "type": "blob", + "sensitive": true + }, + "S2i": { + "type": "list", + "member": { + "shape": "S17" + } + }, + "S2y": { + "type": "structure", + "required": [ + "Path", + "ServerCertificateName", + "ServerCertificateId", + "Arn" + ], + "members": { + "Path": {}, + "ServerCertificateName": {}, + "ServerCertificateId": {}, + "Arn": {}, + "UploadDate": { + "type": "timestamp" + }, + "Expiration": { + "type": "timestamp" + } + } + }, + "S3e": { + "type": "list", + "member": {} + }, + "S3i": { + "type": "list", + "member": { + "shape": "Sm" + } + }, + "S3n": { + "type": "list", + "member": { + "shape": "Sr" + } + }, + "S48": { + "type": "structure", + "required": [ + "UserName", + "CertificateId", + "CertificateBody", + "Status" + ], + "members": { + "UserName": {}, + "CertificateId": {}, + "CertificateBody": {}, + "Status": {}, + "UploadDate": { + "type": "timestamp" + } + } + } + } +} \ No newline at end of file diff --git a/apis/iam-2010-05-08.full.json b/apis/iam-2010-05-08.full.json new file mode 100644 index 0000000000..b82e24132e --- /dev/null +++ b/apis/iam-2010-05-08.full.json @@ -0,0 +1,5322 @@ +{ + "metadata":{ + "apiVersion":"2010-05-08", + "endpointPrefix":"iam", + "globalEndpoint":"iam.amazonaws.com", + "serviceAbbreviation":"IAM", + "serviceFullName":"AWS Identity and Access Management", + "signatureVersion":"v4", + "xmlNamespace":"https://iam.amazonaws.com/doc/2010-05-08/", + "protocol":"query" + }, + "documentation":"AWS Identity and Access Management

AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of the IAM API. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.

We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Signing Requests

Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.

Recording API requests

IAM supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to IAM, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Additional Resources

For more information, see the following:

", + "operations":{ + "AddRoleToInstanceProfile":{ + "name":"AddRoleToInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddRoleToInstanceProfileRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Adds the specified role to the specified instance profile. For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

" + }, + "AddUserToGroup":{ + "name":"AddUserToGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddUserToGroupRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Adds the specified user to the specified group.

" + }, + "ChangePassword":{ + "name":"ChangePassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangePasswordRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"InvalidUserTypeException", + "error":{ + "code":"InvalidUserType", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the type of user for the transaction was incorrect.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"EntityTemporarilyUnmodifiableException", + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

" + }, + { + "shape":"PasswordPolicyViolationException", + "error":{ + "code":"PasswordPolicyViolation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

" + } + ], + "documentation":"

Changes the password of the IAM user calling ChangePassword. The root account password is not affected by this action. For information about modifying passwords, see Managing Passwords in the Using IAM guide.

" + }, + "CreateAccessKey":{ + "name":"CreateAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccessKeyRequest"}, + "output":{ + "shape":"CreateAccessKeyResponse", + "documentation":"

Contains the result of a successful invocation of the CreateAccessKey action.

", + "resultWrapper":"CreateAccessKeyResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this API to manage root credentials even if the AWS account has no associated users.

For information about limits on the number of keys you can create, see Limitations on IAM Entities in the Using IAM guide.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys." + }, + "CreateAccountAlias":{ + "name":"CreateAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccountAliasRequest"}, + "errors":[ + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

This action creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.

" + }, + "CreateGroup":{ + "name":"CreateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGroupRequest"}, + "output":{ + "shape":"CreateGroupResponse", + "documentation":"

Contains the result of a successful invocation of the CreateGroup action.

", + "resultWrapper":"CreateGroupResult" + }, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Creates a new group.

For information about the number of groups you can create, see Limitations on IAM Entities in the Using IAM guide.

" + }, + "CreateInstanceProfile":{ + "name":"CreateInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceProfileRequest"}, + "output":{ + "shape":"CreateInstanceProfileResponse", + "documentation":"

Contains the result of a successful invocation of the CreateInstanceProfile action.

", + "resultWrapper":"CreateInstanceProfileResult" + }, + "errors":[ + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.

For information about the number of instance profiles you can create, see Limitations on IAM Entities in the Using IAM guide.

" + }, + "CreateLoginProfile":{ + "name":"CreateLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoginProfileRequest"}, + "output":{ + "shape":"CreateLoginProfileResponse", + "documentation":"

Contains the result of a successful invocation of the CreateLoginProfile action.

", + "resultWrapper":"CreateLoginProfileResult" + }, + "errors":[ + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"PasswordPolicyViolationException", + "error":{ + "code":"PasswordPolicyViolation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the Using IAM guide.

" + }, + "CreateRole":{ + "name":"CreateRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRoleRequest"}, + "output":{ + "shape":"CreateRoleResponse", + "documentation":"

Contains the result of a successful invocation of the CreateRole action.

", + "resultWrapper":"CreateRoleResult" + }, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

" + } + ], + "documentation":"

Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the Using IAM guide.

The example policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

" + }, + "CreateSAMLProvider":{ + "name":"CreateSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSAMLProviderRequest"}, + "output":{ + "shape":"CreateSAMLProviderResponse", + "documentation":"

Contains the result of a successful invocation of the CreateSAMLProvider action.

", + "resultWrapper":"CreateSAMLProviderResult" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{ + "code":"InvalidInput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.

The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.

When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see Giving Console Access Using SAML and Creating Temporary Security Credentials for SAML Federation in the Using Temporary Credentials guide.

" + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{ + "shape":"CreateUserResponse", + "documentation":"

Contains the result of a successful invocation of the CreateUser action.

", + "resultWrapper":"CreateUserResult" + }, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Creates a new user for your AWS account.

For information about limitations on the number of users you can create, see Limitations on IAM Entities in the Using IAM guide.

" + }, + "CreateVirtualMFADevice":{ + "name":"CreateVirtualMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVirtualMFADeviceRequest"}, + "output":{ + "shape":"CreateVirtualMFADeviceResponse", + "documentation":"

Contains the result of a successful invocation of the CreateVirtualMFADevice action.

", + "resultWrapper":"CreateVirtualMFADeviceResult" + }, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + } + ], + "documentation":"

Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.

For information about limits on the number of MFA devices you can create, see Limitations on Entities in the Using IAM guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures." + }, + "DeactivateMFADevice":{ + "name":"DeactivateMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeactivateMFADeviceRequest"}, + "errors":[ + { + "shape":"EntityTemporarilyUnmodifiableException", + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

" + }, + "DeleteAccessKey":{ + "name":"DeleteAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccessKeyRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the access key associated with the specified user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this API to manage root credentials even if the AWS account has no associated users.

" + }, + "DeleteAccountAlias":{ + "name":"DeleteAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccountAliasRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.

" + }, + "DeleteAccountPasswordPolicy":{ + "name":"DeleteAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the password policy for the AWS account.

" + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"DeleteConflictException", + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified group. The group must not contain any users or have any attached policies.

" + }, + "DeleteGroupPolicy":{ + "name":"DeleteGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupPolicyRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified policy that is associated with the specified group.

" + }, + "DeleteInstanceProfile":{ + "name":"DeleteInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInstanceProfileRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"DeleteConflictException", + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified instance profile. The instance profile must not have an associated role.

Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

For more information about instance profiles, go to About Instance Profiles.

" + }, + "DeleteLoginProfile":{ + "name":"DeleteLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoginProfileRequest"}, + "errors":[ + { + "shape":"EntityTemporarilyUnmodifiableException", + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console.

Deleting a user's password does not prevent a user from accessing IAM through the command line interface or the API. To prevent all user access you must also either make the access key inactive or delete it. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. " + }, + "DeleteRole":{ + "name":"DeleteRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRoleRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"DeleteConflictException", + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.

Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance." + }, + "DeleteRolePolicy":{ + "name":"DeleteRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRolePolicyRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified policy associated with the specified role.

" + }, + "DeleteSAMLProvider":{ + "name":"DeleteSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSAMLProviderRequest"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{ + "code":"InvalidInput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Deletes a SAML provider.

Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail.

" + }, + "DeleteServerCertificate":{ + "name":"DeleteServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServerCertificateRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"DeleteConflictException", + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified server certificate.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference." + }, + "DeleteSigningCertificate":{ + "name":"DeleteSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSigningCertificateRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified signing certificate associated with the specified user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this API to manage root credentials even if the AWS account has no associated users.

" + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"DeleteConflictException", + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

" + } + ], + "documentation":"

Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies.

" + }, + "DeleteUserPolicy":{ + "name":"DeleteUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserPolicyRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes the specified policy associated with the specified user.

" + }, + "DeleteVirtualMFADevice":{ + "name":"DeleteVirtualMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVirtualMFADeviceRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"DeleteConflictException", + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Deletes a virtual MFA device.

" + }, + "EnableMFADevice":{ + "name":"EnableMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableMFADeviceRequest"}, + "errors":[ + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"EntityTemporarilyUnmodifiableException", + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

" + }, + { + "shape":"InvalidAuthenticationCodeException", + "error":{ + "code":"InvalidAuthenticationCode", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the authentication code was not recognized. The error message describes the specific error.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device.

" + }, + "GenerateCredentialReport":{ + "name":"GenerateCredentialReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GenerateCredentialReportResponse", + "documentation":"

Contains the result of a successful invocation of the GenerateCredentialReport action.

", + "resultWrapper":"GenerateCredentialReportResult" + }, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.

" + }, + "GetAccountPasswordPolicy":{ + "name":"GetAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetAccountPasswordPolicyResponse", + "documentation":"

Contains the result of a successful invocation of the GetAccountPasswordPolicy action.

", + "resultWrapper":"GetAccountPasswordPolicyResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.

" + }, + "GetAccountSummary":{ + "name":"GetAccountSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetAccountSummaryResponse", + "documentation":"

Contains the result of a successful invocation of the GetAccountSummary action.

", + "resultWrapper":"GetAccountSummaryResult" + }, + "documentation":"

Retrieves account level information about account entity usage and IAM quotas.

For information about limitations on IAM entities, see Limitations on IAM Entities in the Using IAM guide.

" + }, + "GetCredentialReport":{ + "name":"GetCredentialReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetCredentialReportResponse", + "documentation":"

Contains the result of a successful invocation of the GetCredentialReport action.

", + "resultWrapper":"GetCredentialReportResult" + }, + "errors":[ + { + "shape":"CredentialReportNotPresentException", + "error":{ + "code":"ReportNotPresent", + "httpStatusCode":410, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.

" + }, + { + "shape":"CredentialReportExpiredException", + "error":{ + "code":"ReportExpired", + "httpStatusCode":410, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the Using IAM guide.

" + }, + { + "shape":"CredentialReportNotReadyException", + "error":{ + "code":"ReportInProgress", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the credential report is still being generated.

" + } + ], + "documentation":"

Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.

" + }, + "GetGroup":{ + "name":"GetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGroupRequest"}, + "output":{ + "shape":"GetGroupResponse", + "documentation":"

Contains the result of a successful invocation of the GetGroup action.

", + "resultWrapper":"GetGroupResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Returns a list of users that are in the specified group. You can paginate the results using the MaxItems and Marker parameters.

" + }, + "GetGroupPolicy":{ + "name":"GetGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGroupPolicyRequest"}, + "output":{ + "shape":"GetGroupPolicyResponse", + "documentation":"

Contains the result of a successful invocation of the GetGroupPolicy action.

", + "resultWrapper":"GetGroupPolicyResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves the specified policy document for the specified group. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

" + }, + "GetInstanceProfile":{ + "name":"GetInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInstanceProfileRequest"}, + "output":{ + "shape":"GetInstanceProfileResponse", + "documentation":"

Contains the result of a successful invocation of the GetInstanceProfile action.

", + "resultWrapper":"GetInstanceProfileResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to About Instance Profiles. For more information about ARNs, go to ARNs.

" + }, + "GetLoginProfile":{ + "name":"GetLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoginProfileRequest"}, + "output":{ + "shape":"GetLoginProfileResponse", + "documentation":"

Contains the result of a successful invocation of the GetLoginProfile action.

", + "resultWrapper":"GetLoginProfileResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves the user name and password-creation date for the specified user. If the user has not been assigned a password, the action returns a 404 (NoSuchEntity) error.

" + }, + "GetRole":{ + "name":"GetRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRoleRequest"}, + "output":{ + "shape":"GetRoleResponse", + "documentation":"

Contains the result of a successful invocation of the GetRole action.

", + "resultWrapper":"GetRoleResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to ARNs. For more information about roles, go to Working with Roles.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

" + }, + "GetRolePolicy":{ + "name":"GetRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRolePolicyRequest"}, + "output":{ + "shape":"GetRolePolicyResponse", + "documentation":"

Contains the result of a successful invocation of the GetRolePolicy action.

", + "resultWrapper":"GetRolePolicyResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves the specified policy document for the specified role. For more information about roles, go to Working with Roles.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

" + }, + "GetSAMLProvider":{ + "name":"GetSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSAMLProviderRequest"}, + "output":{ + "shape":"GetSAMLProviderResponse", + "documentation":"

Contains the result of a successful invocation of the GetSAMLProvider action.

", + "resultWrapper":"GetSAMLProviderResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"InvalidInputException", + "error":{ + "code":"InvalidInput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ], + "documentation":"

Returns the SAML provider metadocument that was uploaded when the provider was created or updated.

" + }, + "GetServerCertificate":{ + "name":"GetServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServerCertificateRequest"}, + "output":{ + "shape":"GetServerCertificateResponse", + "documentation":"

Contains the result of a successful invocation of the GetServerCertificate action.

", + "resultWrapper":"GetServerCertificateResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves information about the specified server certificate.

" + }, + "GetUser":{ + "name":"GetUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserRequest"}, + "output":{ + "shape":"GetUserResponse", + "documentation":"

Contains the result of a successful invocation of the GetUser action.

", + "resultWrapper":"GetUserResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves information about the specified user, including the user's path, unique ID, and ARN.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request.

" + }, + "GetUserPolicy":{ + "name":"GetUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserPolicyRequest"}, + "output":{ + "shape":"GetUserPolicyResponse", + "documentation":"

Contains the result of a successful invocation of the GetUserPolicy action.

", + "resultWrapper":"GetUserPolicyResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Retrieves the specified policy document for the specified user. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

" + }, + "ListAccessKeys":{ + "name":"ListAccessKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccessKeysRequest"}, + "output":{ + "shape":"ListAccessKeysResponse", + "documentation":"

Contains the result of a successful invocation of the ListAccessKeys action.

", + "resultWrapper":"ListAccessKeysResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, this API can be used to manage root credentials even if the AWS account has no associated users.

" + }, + "ListAccountAliases":{ + "name":"ListAccountAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccountAliasesRequest"}, + "output":{ + "shape":"ListAccountAliasesResponse", + "documentation":"

Contains the result of a successful invocation of the ListAccountAliases action.

", + "resultWrapper":"ListAccountAliasesResult" + }, + "documentation":"

Lists the account aliases associated with the account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListGroupPolicies":{ + "name":"ListGroupPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupPoliciesRequest"}, + "output":{ + "shape":"ListGroupPoliciesResponse", + "documentation":"

Contains the result of a successful invocation of the ListGroupPolicies action.

", + "resultWrapper":"ListGroupPoliciesResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Lists the names of the policies associated with the specified group. If there are none, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsRequest"}, + "output":{ + "shape":"ListGroupsResponse", + "documentation":"

Contains the result of a successful invocation of the ListGroups action.

", + "resultWrapper":"ListGroupsResult" + }, + "documentation":"

Lists the groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListGroupsForUser":{ + "name":"ListGroupsForUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsForUserRequest"}, + "output":{ + "shape":"ListGroupsForUserResponse", + "documentation":"

Contains the result of a successful invocation of the ListGroupsForUser action.

", + "resultWrapper":"ListGroupsForUserResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Lists the groups the specified user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListInstanceProfiles":{ + "name":"ListInstanceProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceProfilesRequest"}, + "output":{ + "shape":"ListInstanceProfilesResponse", + "documentation":"

Contains the result of a successful invocation of the ListInstanceProfiles action.

", + "resultWrapper":"ListInstanceProfilesResult" + }, + "documentation":"

Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListInstanceProfilesForRole":{ + "name":"ListInstanceProfilesForRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceProfilesForRoleRequest"}, + "output":{ + "shape":"ListInstanceProfilesForRoleResponse", + "documentation":"

Contains the result of a successful invocation of the ListInstanceProfilesForRole action.

", + "resultWrapper":"ListInstanceProfilesForRoleResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListMFADevices":{ + "name":"ListMFADevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMFADevicesRequest"}, + "output":{ + "shape":"ListMFADevicesResponse", + "documentation":"

Contains the result of a successful invocation of the ListMFADevices action.

", + "resultWrapper":"ListMFADevicesResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListRolePolicies":{ + "name":"ListRolePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRolePoliciesRequest"}, + "output":{ + "shape":"ListRolePoliciesResponse", + "documentation":"

Contains the result of a successful invocation of the ListRolePolicies action.

", + "resultWrapper":"ListRolePoliciesResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Lists the names of the policies associated with the specified role. If there are none, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListRoles":{ + "name":"ListRoles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRolesRequest"}, + "output":{ + "shape":"ListRolesResponse", + "documentation":"

Contains the result of a successful invocation of the ListRoles action.

", + "resultWrapper":"ListRolesResult" + }, + "documentation":"

Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.

You can paginate the results using the MaxItems and Marker parameters.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

" + }, + "ListSAMLProviders":{ + "name":"ListSAMLProviders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSAMLProvidersRequest"}, + "output":{ + "shape":"ListSAMLProvidersResponse", + "documentation":"

Contains the result of a successful invocation of the ListSAMLProviders action.

", + "resultWrapper":"ListSAMLProvidersResult" + }, + "documentation":"

Lists the SAML providers in the account.

" + }, + "ListServerCertificates":{ + "name":"ListServerCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServerCertificatesRequest"}, + "output":{ + "shape":"ListServerCertificatesResponse", + "documentation":"

Contains the result of a successful invocation of the ListServerCertificates action.

", + "resultWrapper":"ListServerCertificatesResult" + }, + "documentation":"

Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListSigningCertificates":{ + "name":"ListSigningCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSigningCertificatesRequest"}, + "output":{ + "shape":"ListSigningCertificatesResponse", + "documentation":"

Contains the result of a successful invocation of the ListSigningCertificates action.

", + "resultWrapper":"ListSigningCertificatesResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list.

Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, this API can be used to manage root credentials even if the AWS account has no associated users.

" + }, + "ListUserPolicies":{ + "name":"ListUserPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUserPoliciesRequest"}, + "output":{ + "shape":"ListUserPoliciesResponse", + "documentation":"

Contains the result of a successful invocation of the ListUserPolicies action.

", + "resultWrapper":"ListUserPoliciesResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Lists the names of the policies associated with the specified user. If there are none, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{ + "shape":"ListUsersResponse", + "documentation":"

Contains the result of a successful invocation of the ListUsers action.

", + "resultWrapper":"ListUsersResult" + }, + "documentation":"

Lists the users that have the specified path prefix. If there are none, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListVirtualMFADevices":{ + "name":"ListVirtualMFADevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVirtualMFADevicesRequest"}, + "output":{ + "shape":"ListVirtualMFADevicesResponse", + "documentation":"

Contains the result of a successful invocation of the ListVirtualMFADevices action.

", + "resultWrapper":"ListVirtualMFADevicesResult" + }, + "documentation":"

Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "PutGroupPolicy":{ + "name":"PutGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutGroupPolicyRequest"}, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Adds (or updates) a policy document associated with the specified group. For information about policies, refer to Overview of Policies in the Using IAM guide.

For information about limits on the number of policies you can associate with a group, see Limitations on IAM Entities in the Using IAM guide.

" + }, + "PutRolePolicy":{ + "name":"PutRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRolePolicyRequest"}, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Adds (or updates) a policy document associated with the specified role. For information about policies, go to Overview of Policies in the Using IAM guide.

For information about limits on the policies you can associate with a role, see Limitations on IAM Entities in the Using IAM guide.

" + }, + "PutUserPolicy":{ + "name":"PutUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutUserPolicyRequest"}, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Adds (or updates) a policy document associated with the specified user. For information about policies, refer to Overview of Policies in the Using IAM guide.

For information about limits on the number of policies you can associate with a user, see Limitations on IAM Entities in the Using IAM guide.

" + }, + "RemoveRoleFromInstanceProfile":{ + "name":"RemoveRoleFromInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveRoleFromInstanceProfileRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Removes the specified role from the specified instance profile.

Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance will break any applications running on the instance.

For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

" + }, + "RemoveUserFromGroup":{ + "name":"RemoveUserFromGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveUserFromGroupRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Removes the specified user from the specified group.

" + }, + "ResyncMFADevice":{ + "name":"ResyncMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResyncMFADeviceRequest"}, + "errors":[ + { + "shape":"InvalidAuthenticationCodeException", + "error":{ + "code":"InvalidAuthenticationCode", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the authentication code was not recognized. The error message describes the specific error.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Synchronizes the specified MFA device with AWS servers.

" + }, + "UpdateAccessKey":{ + "name":"UpdateAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccessKeyRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, this API can be used to manage root credentials even if the AWS account has no associated users.

For information about rotating keys, see Managing Keys and Certificates in the Using IAM guide.

" + }, + "UpdateAccountPasswordPolicy":{ + "name":"UpdateAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccountPasswordPolicyRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Updates the password policy settings for the AWS account.

For more information about using a password policy, see Managing an IAM Password Policy in the Using IAM guide.

" + }, + "UpdateAssumeRolePolicy":{ + "name":"UpdateAssumeRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssumeRolePolicyRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Updates the policy that grants an entity permission to assume a role. For more information about roles, go to Working with Roles.

" + }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGroupRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Updates the name and/or the path of the specified group.

You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the Using IAM guide. " + }, + "UpdateLoginProfile":{ + "name":"UpdateLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLoginProfileRequest"}, + "errors":[ + { + "shape":"EntityTemporarilyUnmodifiableException", + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"PasswordPolicyViolationException", + "error":{ + "code":"PasswordPolicyViolation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Changes the password for the specified user.

" + }, + "UpdateSAMLProvider":{ + "name":"UpdateSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSAMLProviderRequest"}, + "output":{ + "shape":"UpdateSAMLProviderResponse", + "documentation":"

Contains the result of a successful invocation of the UpdateSAMLProvider action.

", + "resultWrapper":"UpdateSAMLProviderResult" + }, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"InvalidInputException", + "error":{ + "code":"InvalidInput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Updates the metadata document for an existing SAML provider.

" + }, + "UpdateServerCertificate":{ + "name":"UpdateServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServerCertificateRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Updates the name and/or the path of the specified server certificate.

You should understand the implications of changing a server certificate's path or name. For more information, see Managing Server Certificates in the Using IAM guide. " + }, + "UpdateSigningCertificate":{ + "name":"UpdateSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSigningCertificateRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + } + ], + "documentation":"

Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, this API can be used to manage root credentials even if the AWS account has no associated users.

For information about rotating certificates, see Managing Keys and Certificates in the Using IAM guide.

" + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserRequest"}, + "errors":[ + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"EntityTemporarilyUnmodifiableException", + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

" + } + ], + "documentation":"

Updates the name and/or the path of the specified user.

You should understand the implications of changing a user's path or name. For more information, see Renaming Users and Groups in the Using IAM guide. " + }, + "UploadServerCertificate":{ + "name":"UploadServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadServerCertificateRequest"}, + "output":{ + "shape":"UploadServerCertificateResponse", + "documentation":"

Contains the result of a successful invocation of the UploadServerCertificate action.

", + "resultWrapper":"UploadServerCertificateResult" + }, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"MalformedCertificateException", + "error":{ + "code":"MalformedCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

" + }, + { + "shape":"KeyPairMismatchException", + "error":{ + "code":"KeyPairMismatch", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the public key certificate and the private key do not match.

" + } + ], + "documentation":"

Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

For information about the number of server certificates you can upload, see Limitations on IAM Entities in the Using IAM guide.

" + }, + "UploadSigningCertificate":{ + "name":"UploadSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadSigningCertificateRequest"}, + "output":{ + "shape":"UploadSigningCertificateResponse", + "documentation":"

Contains the result of a successful invocation of the UploadSigningCertificate action.

", + "resultWrapper":"UploadSigningCertificateResult" + }, + "errors":[ + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + { + "shape":"EntityAlreadyExistsException", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + { + "shape":"MalformedCertificateException", + "error":{ + "code":"MalformedCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

" + }, + { + "shape":"InvalidCertificateException", + "error":{ + "code":"InvalidCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the certificate is invalid.

" + }, + { + "shape":"DuplicateCertificateException", + "error":{ + "code":"DuplicateCertificate", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the same certificate is associated to another user under the account.

" + }, + { + "shape":"NoSuchEntityException", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + } + ], + "documentation":"

Uploads an X.509 signing certificate and associates it with the specified user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, this API can be used to manage root credentials even if the AWS account has no associated users.

" + } + }, + "shapes":{ + "AccessKey":{ + "type":"structure", + "required":[ + "UserName", + "AccessKeyId", + "Status", + "SecretAccessKey" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

Name of the user the key is associated with.

" + }, + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The ID for this access key.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

" + }, + "SecretAccessKey":{ + "shape":"accessKeySecretType", + "documentation":"

The secret key used to sign requests.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the access key was created.

" + } + }, + "documentation":"

The AccessKey data type contains information about an AWS access key.

This data type is used as a response element in the actions CreateAccessKey and ListAccessKeys.

" + }, + "AccessKeyMetadata":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

Name of the user the key is associated with.

" + }, + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The ID for this access key.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the access key was created.

" + } + }, + "documentation":"

The AccessKey data type contains information about an AWS access key, without its secret key.

This data type is used as a response element in the action ListAccessKeys.

" + }, + "AddRoleToInstanceProfileRequest":{ + "type":"structure", + "required":[ + "InstanceProfileName", + "RoleName" + ], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

Name of the instance profile to update.

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role to add.

" + } + } + }, + "AddUserToGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserName" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group to update.

" + }, + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user to add.

" + } + } + }, + "BootstrapDatum":{ + "type":"blob", + "sensitive":true + }, + "ChangePasswordRequest":{ + "type":"structure", + "required":[ + "OldPassword", + "NewPassword" + ], + "members":{ + "OldPassword":{ + "shape":"passwordType", + "documentation":"

The IAM users's current password.

" + }, + "NewPassword":{ + "shape":"passwordType", + "documentation":"

The new password. The new password must conform to the AWS account's password policy, if one exists.

" + } + } + }, + "CreateAccessKeyRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The user name that the new key will belong to.

" + } + } + }, + "CreateAccessKeyResponse":{ + "type":"structure", + "required":["AccessKey"], + "members":{ + "AccessKey":{ + "shape":"AccessKey", + "documentation":"

Information about the access key.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the CreateAccessKey action.

" + }, + "CreateAccountAliasRequest":{ + "type":"structure", + "required":["AccountAlias"], + "members":{ + "AccountAlias":{ + "shape":"accountAliasType", + "documentation":"

Name of the account alias to create.

" + } + } + }, + "CreateGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the group. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

" + }, + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group to create. Do not include the path in this value.

" + } + } + }, + "CreateGroupResponse":{ + "type":"structure", + "required":["Group"], + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

Information about the group.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the CreateGroup action.

" + }, + "CreateInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

Name of the instance profile to create.

" + }, + "Path":{ + "shape":"pathType", + "documentation":"

The path to the instance profile. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

" + } + } + }, + "CreateInstanceProfileResponse":{ + "type":"structure", + "required":["InstanceProfile"], + "members":{ + "InstanceProfile":{ + "shape":"InstanceProfile", + "documentation":"

Information about the instance profile.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the CreateInstanceProfile action.

" + }, + "CreateLoginProfileRequest":{ + "type":"structure", + "required":[ + "UserName", + "Password" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

Name of the user to create a password for.

" + }, + "Password":{ + "shape":"passwordType", + "documentation":"

The new password for the user.

" + }, + "PasswordResetRequired":{ + "shape":"booleanType", + "documentation":"

Specifies whether the user is required to set a new password on next sign-in.

" + } + } + }, + "CreateLoginProfileResponse":{ + "type":"structure", + "required":["LoginProfile"], + "members":{ + "LoginProfile":{ + "shape":"LoginProfile", + "documentation":"

The user name and password create date.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the CreateLoginProfile action.

" + }, + "CreateRoleRequest":{ + "type":"structure", + "required":[ + "RoleName", + "AssumeRolePolicyDocument" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role to create.

" + }, + "AssumeRolePolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy that grants an entity permission to assume the role.

" + } + } + }, + "CreateRoleResponse":{ + "type":"structure", + "required":["Role"], + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

Information about the role.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the CreateRole action.

" + }, + "CreateSAMLProviderRequest":{ + "type":"structure", + "required":[ + "SAMLMetadataDocument", + "Name" + ], + "members":{ + "SAMLMetadataDocument":{ + "shape":"SAMLMetadataDocumentType", + "documentation":"

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see Creating Temporary Security Credentials for SAML Federation in the Using Temporary Security Credentials guide.

" + }, + "Name":{ + "shape":"SAMLProviderNameType", + "documentation":"

The name of the provider to create.

" + } + } + }, + "CreateSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the CreateSAMLProvider action.

" + }, + "CreateUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path for the user name. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

" + }, + "UserName":{ + "shape":"userNameType", + "documentation":"

Name of the user to create.

" + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

Information about the user.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the CreateUser action.

" + }, + "CreateVirtualMFADeviceRequest":{ + "type":"structure", + "required":["VirtualMFADeviceName"], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path for the virtual MFA device. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

" + }, + "VirtualMFADeviceName":{ + "shape":"virtualMFADeviceName", + "documentation":"

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.

" + } + } + }, + "CreateVirtualMFADeviceResponse":{ + "type":"structure", + "required":["VirtualMFADevice"], + "members":{ + "VirtualMFADevice":{ + "shape":"VirtualMFADevice", + "documentation":"

A newly created virtual MFA device.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the CreateVirtualMFADevice action.

" + }, + "CredentialReportExpiredException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportExpiredExceptionMessage"} + }, + "error":{ + "code":"ReportExpired", + "httpStatusCode":410, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the Using IAM guide.

" + }, + "CredentialReportNotPresentException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportNotPresentExceptionMessage"} + }, + "error":{ + "code":"ReportNotPresent", + "httpStatusCode":410, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.

" + }, + "CredentialReportNotReadyException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportNotReadyExceptionMessage"} + }, + "error":{ + "code":"ReportInProgress", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the credential report is still being generated.

" + }, + "DeactivateMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user whose MFA device you want to deactivate.

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

" + } + } + }, + "DeleteAccessKeyRequest":{ + "type":"structure", + "required":["AccessKeyId"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user whose key you want to delete.

" + }, + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The access key ID for the access key ID and secret access key you want to delete.

" + } + } + }, + "DeleteAccountAliasRequest":{ + "type":"structure", + "required":["AccountAlias"], + "members":{ + "AccountAlias":{ + "shape":"accountAliasType", + "documentation":"

Name of the account alias to delete.

" + } + } + }, + "DeleteConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"deleteConflictMessage"} + }, + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

" + }, + "DeleteGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document to delete.

" + } + } + }, + "DeleteGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group to delete.

" + } + } + }, + "DeleteInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

Name of the instance profile to delete.

" + } + } + }, + "DeleteLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

Name of the user whose password you want to delete.

" + } + } + }, + "DeleteRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role the associated with the policy.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document to delete.

" + } + } + }, + "DeleteRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role to delete.

" + } + } + }, + "DeleteSAMLProviderRequest":{ + "type":"structure", + "required":["SAMLProviderArn"], + "members":{ + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to delete.

" + } + } + }, + "DeleteServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name of the server certificate you want to delete.

" + } + } + }, + "DeleteSigningCertificateRequest":{ + "type":"structure", + "required":["CertificateId"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user the signing certificate belongs to.

" + }, + "CertificateId":{ + "shape":"certificateIdType", + "documentation":"

ID of the signing certificate to delete.

" + } + } + }, + "DeleteUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document to delete.

" + } + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user to delete.

" + } + } + }, + "DeleteVirtualMFADeviceRequest":{ + "type":"structure", + "required":["SerialNumber"], + "members":{ + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.

" + } + } + }, + "DuplicateCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"duplicateCertificateMessage"} + }, + "error":{ + "code":"DuplicateCertificate", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the same certificate is associated to another user under the account.

" + }, + "EnableMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user for whom you want to enable the MFA device.

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

" + }, + "AuthenticationCode1":{ + "shape":"authenticationCodeType", + "documentation":"

An authentication code emitted by the device.

" + }, + "AuthenticationCode2":{ + "shape":"authenticationCodeType", + "documentation":"

A subsequent authentication code emitted by the device.

" + } + } + }, + "EntityAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"entityAlreadyExistsMessage"} + }, + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

" + }, + "EntityTemporarilyUnmodifiableException":{ + "type":"structure", + "members":{ + "message":{"shape":"entityTemporarilyUnmodifiableMessage"} + }, + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

" + }, + "GenerateCredentialReportResponse":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ReportStateType", + "documentation":"

Information about the state of a credential report.

" + }, + "Description":{ + "shape":"ReportStateDescriptionType", + "documentation":"

Information about the credential report.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GenerateCredentialReport action.

" + }, + "GetAccountPasswordPolicyResponse":{ + "type":"structure", + "required":["PasswordPolicy"], + "members":{ + "PasswordPolicy":{"shape":"PasswordPolicy"} + }, + "documentation":"

Contains the result of a successful invocation of the GetAccountPasswordPolicy action.

" + }, + "GetAccountSummaryResponse":{ + "type":"structure", + "members":{ + "SummaryMap":{ + "shape":"summaryMapType", + "documentation":"

A set of key value pairs containing account-level information.

SummaryMap contains the following keys:

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetAccountSummary action.

" + }, + "GetCredentialReportResponse":{ + "type":"structure", + "members":{ + "Content":{ + "shape":"ReportContentType", + "documentation":"

Contains the credential report. The report is Base64-encoded.

" + }, + "ReportFormat":{ + "shape":"ReportFormatType", + "documentation":"

The format (MIME type) of the credential report.

" + }, + "GeneratedTime":{ + "shape":"dateType", + "documentation":"

The time and date when the credential report was created, in ISO 8601 date-time format.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetCredentialReport action.

" + }, + "GetGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document to get.

" + } + } + }, + "GetGroupPolicyResponse":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The group the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetGroupPolicy action.

" + }, + "GetGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "GetGroupResponse":{ + "type":"structure", + "required":[ + "Group", + "Users" + ], + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

Information about the group.

" + }, + "Users":{ + "shape":"userListType", + "documentation":"

A list of users in the group.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more user names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more user names in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, then this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetGroup action.

" + }, + "GetInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

Name of the instance profile to get information about.

" + } + } + }, + "GetInstanceProfileResponse":{ + "type":"structure", + "required":["InstanceProfile"], + "members":{ + "InstanceProfile":{ + "shape":"InstanceProfile", + "documentation":"

Information about the instance profile.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetInstanceProfile action.

" + }, + "GetLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

Name of the user whose login profile you want to retrieve.

" + } + } + }, + "GetLoginProfileResponse":{ + "type":"structure", + "required":["LoginProfile"], + "members":{ + "LoginProfile":{ + "shape":"LoginProfile", + "documentation":"

User name and password create date for the user.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetLoginProfile action.

" + }, + "GetRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role associated with the policy.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document to get.

" + } + } + }, + "GetRolePolicyResponse":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The role the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetRolePolicy action.

" + }, + "GetRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role to get information about.

" + } + } + }, + "GetRoleResponse":{ + "type":"structure", + "required":["Role"], + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

Information about the role.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetRole action.

" + }, + "GetSAMLProviderRequest":{ + "type":"structure", + "required":["SAMLProviderArn"], + "members":{ + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to get information about.

" + } + } + }, + "GetSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLMetadataDocument":{ + "shape":"SAMLMetadataDocumentType", + "documentation":"

The XML metadata document that includes information about an identity provider.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time when the SAML provider was created.

" + }, + "ValidUntil":{ + "shape":"dateType", + "documentation":"

The expiration date and time for the SAML provider.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetSAMLProvider action.

" + }, + "GetServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name of the server certificate you want to retrieve information about.

" + } + } + }, + "GetServerCertificateResponse":{ + "type":"structure", + "required":["ServerCertificate"], + "members":{ + "ServerCertificate":{ + "shape":"ServerCertificate", + "documentation":"

Information about the server certificate.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetServerCertificate action.

" + }, + "GetUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user who the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document to get.

" + } + } + }, + "GetUserPolicyResponse":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The user the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetUserPolicy action.

" + }, + "GetUserRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user to get information about.

This parameter is optional. If it is not included, it defaults to the user making the request.

" + } + } + }, + "GetUserResponse":{ + "type":"structure", + "required":["User"], + "members":{ + "User":{ + "shape":"User", + "documentation":"

Information about the user.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the GetUser action.

" + }, + "Group":{ + "type":"structure", + "required":[ + "Path", + "GroupName", + "GroupId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

Path to the group. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name that identifies the group.

" + }, + "GroupId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the group was created.

" + } + }, + "documentation":"

The Group data type contains information about a group.

This data type is used as a response element in the following actions:

" + }, + "InstanceProfile":{ + "type":"structure", + "required":[ + "Path", + "InstanceProfileName", + "InstanceProfileId", + "Arn", + "CreateDate", + "Roles" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

Path to the instance profile. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

The name identifying the instance profile.

" + }, + "InstanceProfileId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the instance profile. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the instance profile was created.

" + }, + "Roles":{ + "shape":"roleListType", + "documentation":"

The role associated with the instance profile.

" + } + }, + "documentation":"

The InstanceProfile data type contains information about an instance profile.

This data type is used as a response element in the following actions:

" + }, + "InvalidAuthenticationCodeException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidAuthenticationCodeMessage"} + }, + "error":{ + "code":"InvalidAuthenticationCode", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the authentication code was not recognized. The error message describes the specific error.

" + }, + "InvalidCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidCertificateMessage"} + }, + "error":{ + "code":"InvalidCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the certificate is invalid.

" + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidInputMessage"} + }, + "error":{ + "code":"InvalidInput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidUserTypeException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidUserTypeMessage"} + }, + "error":{ + "code":"InvalidUserType", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the type of user for the transaction was incorrect.

" + }, + "KeyPairMismatchException":{ + "type":"structure", + "members":{ + "message":{"shape":"keyPairMismatchMessage"} + }, + "error":{ + "code":"KeyPairMismatch", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the public key certificate and the private key do not match.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"limitExceededMessage"} + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

" + }, + "ListAccessKeysRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this parameter only when paginating results to indicate the maximum number of keys you want in the response. If there are additional keys beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListAccessKeysResponse":{ + "type":"structure", + "required":["AccessKeyMetadata"], + "members":{ + "AccessKeyMetadata":{ + "shape":"accessKeyMetadataListType", + "documentation":"

A list of access key metadata.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more keys to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more keys in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListAccessKeys action.

" + }, + "ListAccountAliasesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of account aliases you want in the response. If there are additional account aliases beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListAccountAliasesResponse":{ + "type":"structure", + "required":["AccountAliases"], + "members":{ + "AccountAliases":{ + "shape":"accountAliasListType", + "documentation":"

A list of aliases associated with the account.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more account aliases to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more account aliases in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListAccountAliases action.

" + }, + "ListGroupPoliciesRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the group to list policies for.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional policy names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListGroupPoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{ + "shape":"policyNameListType", + "documentation":"

A list of policy names.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListGroupPolicies action.

" + }, + "ListGroupsForUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to list groups for.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListGroupsForUserResponse":{ + "type":"structure", + "required":["Groups"], + "members":{ + "Groups":{ + "shape":"groupListType", + "documentation":"

A list of groups.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more groups in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListGroupsForUser action.

" + }, + "ListGroupsRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListGroupsResponse":{ + "type":"structure", + "required":["Groups"], + "members":{ + "Groups":{ + "shape":"groupListType", + "documentation":"

A list of groups.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more groups in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListGroups action.

" + }, + "ListInstanceProfilesForRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to list instance profiles for.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListInstanceProfilesForRoleResponse":{ + "type":"structure", + "required":["InstanceProfiles"], + "members":{ + "InstanceProfiles":{ + "shape":"instanceProfileListType", + "documentation":"

A list of instance profiles.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more instance profiles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more instance profiles in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListInstanceProfilesForRole action.

" + }, + "ListInstanceProfilesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all instance profiles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListInstanceProfilesResponse":{ + "type":"structure", + "required":["InstanceProfiles"], + "members":{ + "InstanceProfiles":{ + "shape":"instanceProfileListType", + "documentation":"

A list of instance profiles.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more instance profiles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more instance profiles in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListInstanceProfiles action.

" + }, + "ListMFADevicesRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user whose MFA devices you want to list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of MFA devices you want in the response. If there are additional MFA devices beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListMFADevicesResponse":{ + "type":"structure", + "required":["MFADevices"], + "members":{ + "MFADevices":{ + "shape":"mfaDeviceListType", + "documentation":"

A list of MFA devices.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more MFA devices to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more MFA devices in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListMFADevices action.

" + }, + "ListRolePoliciesRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to list policies for.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListRolePoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{ + "shape":"policyNameListType", + "documentation":"

A list of policy names.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListRolePolicies action.

" + }, + "ListRolesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListRolesResponse":{ + "type":"structure", + "required":["Roles"], + "members":{ + "Roles":{ + "shape":"roleListType", + "documentation":"

A list of roles.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more roles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more roles in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListRoles action.

" + }, + "ListSAMLProvidersRequest":{ + "type":"structure", + "members":{ + } + }, + "ListSAMLProvidersResponse":{ + "type":"structure", + "members":{ + "SAMLProviderList":{ + "shape":"SAMLProviderListType", + "documentation":"

The list of SAML providers for this account.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListSAMLProviders action.

" + }, + "ListServerCertificatesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of server certificates you want in the response. If there are additional server certificates beyond the maximum you specify, the IsTruncated response element will be set to true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListServerCertificatesResponse":{ + "type":"structure", + "required":["ServerCertificateMetadataList"], + "members":{ + "ServerCertificateMetadataList":{ + "shape":"serverCertificateMetadataListType", + "documentation":"

A list of server certificates.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more server certificates to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more server certificates in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListServerCertificates action.

" + }, + "ListSigningCertificatesRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of certificate IDs you want in the response. If there are additional certificate IDs beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListSigningCertificatesResponse":{ + "type":"structure", + "required":["Certificates"], + "members":{ + "Certificates":{ + "shape":"certificateListType", + "documentation":"

A list of the user's signing certificate information.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more certificate IDs to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more certificates in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListSigningCertificates action.

" + }, + "ListUserPoliciesRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to list policies for.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional policy names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListUserPoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{ + "shape":"policyNameListType", + "documentation":"

A list of policy names.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListUserPolicies action.

" + }, + "ListUsersRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "required":["Users"], + "members":{ + "Users":{ + "shape":"userListType", + "documentation":"

A list of users.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more user names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more users in the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListUsers action.

" + }, + "ListVirtualMFADevicesRequest":{ + "type":"structure", + "members":{ + "AssignmentStatus":{ + "shape":"assignmentStatusType", + "documentation":"

The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

" + } + } + }, + "ListVirtualMFADevicesResponse":{ + "type":"structure", + "required":["VirtualMFADevices"], + "members":{ + "VirtualMFADevices":{"shape":"virtualMFADeviceListType"}, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items the list.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ListVirtualMFADevices action.

" + }, + "LoginProfile":{ + "type":"structure", + "required":[ + "UserName", + "CreateDate" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the user, which can be used for signing in to the AWS Management Console.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the password for the user was created.

" + }, + "PasswordResetRequired":{ + "shape":"booleanType", + "documentation":"

Specifies whether the user is required to set a new password on next sign-in.

" + } + }, + "documentation":"

The LoginProfile data type contains the user name and password create date for a user.

This data type is used as a response element in the actions CreateLoginProfile and GetLoginProfile.

" + }, + "MFADevice":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "EnableDate" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The user with whom the MFA device is associated.

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

" + }, + "EnableDate":{ + "shape":"dateType", + "documentation":"

The date when the MFA device was enabled for the user.

" + } + }, + "documentation":"

The MFADevice data type contains information about an MFA device.

This data type is used as a response element in the action ListMFADevices.

" + }, + "MalformedCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"malformedCertificateMessage"} + }, + "error":{ + "code":"MalformedCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

" + }, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "message":{"shape":"malformedPolicyDocumentMessage"} + }, + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

" + }, + "NoSuchEntityException":{ + "type":"structure", + "members":{ + "message":{"shape":"noSuchEntityMessage"} + }, + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

" + }, + "PasswordPolicy":{ + "type":"structure", + "members":{ + "MinimumPasswordLength":{ + "shape":"minimumPasswordLengthType", + "documentation":"

Minimum length to require for IAM user passwords.

" + }, + "RequireSymbols":{ + "shape":"booleanType", + "documentation":"

Specifies whether to require symbols for IAM user passwords.

" + }, + "RequireNumbers":{ + "shape":"booleanType", + "documentation":"

Specifies whether to require numbers for IAM user passwords.

" + }, + "RequireUppercaseCharacters":{ + "shape":"booleanType", + "documentation":"

Specifies whether to require uppercase characters for IAM user passwords.

" + }, + "RequireLowercaseCharacters":{ + "shape":"booleanType", + "documentation":"

Specifies whether to require lowercase characters for IAM user passwords.

" + }, + "AllowUsersToChangePassword":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM users are allowed to change their own password.

" + }, + "ExpirePasswords":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM users are required to change their password after a specified number of days.

" + }, + "MaxPasswordAge":{ + "shape":"maxPasswordAgeType", + "documentation":"

The number of days that an IAM user password is valid.

" + }, + "PasswordReusePrevention":{ + "shape":"passwordReusePreventionType", + "documentation":"

Specifies the number of previous passwords that IAM users are prevented from reusing.

" + }, + "HardExpiry":{ + "shape":"booleanObjectType", + "documentation":"

Specifies whether IAM users are prevented from setting a new password after their password has expired.

" + } + }, + "documentation":"

The PasswordPolicy data type contains information about the account password policy.

This data type is used as a response element in the action GetAccountPasswordPolicy.

" + }, + "PasswordPolicyViolationException":{ + "type":"structure", + "members":{ + "message":{"shape":"passwordPolicyViolationMessage"} + }, + "error":{ + "code":"PasswordPolicyViolation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

" + }, + "PutGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group to associate the policy with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

" + } + } + }, + "PutRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role to associate the policy with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

" + } + } + }, + "PutUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user to associate the policy with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

Name of the policy document.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

" + } + } + }, + "RemoveRoleFromInstanceProfileRequest":{ + "type":"structure", + "required":[ + "InstanceProfileName", + "RoleName" + ], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

Name of the instance profile to update.

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role to remove.

" + } + } + }, + "RemoveUserFromGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserName" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group to update.

" + }, + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user to remove.

" + } + } + }, + "ReportContentType":{"type":"blob"}, + "ReportFormatType":{ + "type":"string", + "enum":["text/csv"] + }, + "ReportStateDescriptionType":{"type":"string"}, + "ReportStateType":{ + "type":"string", + "enum":[ + "STARTED", + "INPROGRESS", + "COMPLETE" + ] + }, + "ResyncMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user whose MFA device you want to resynchronize.

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

Serial number that uniquely identifies the MFA device.

" + }, + "AuthenticationCode1":{ + "shape":"authenticationCodeType", + "documentation":"

An authentication code emitted by the device.

" + }, + "AuthenticationCode2":{ + "shape":"authenticationCodeType", + "documentation":"

A subsequent authentication code emitted by the device.

" + } + } + }, + "Role":{ + "type":"structure", + "required":[ + "Path", + "RoleName", + "RoleId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

Path to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name identifying the role.

" + }, + "RoleId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the role was created.

" + }, + "AssumeRolePolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy that grants an entity permission to assume the role.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

" + } + }, + "documentation":"

The Role data type contains information about a role.

This data type is used as a response element in the following actions:

" + }, + "SAMLMetadataDocumentType":{ + "type":"string", + "min":1000, + "max":10000000 + }, + "SAMLProviderListEntry":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider.

" + }, + "ValidUntil":{ + "shape":"dateType", + "documentation":"

The expiration date and time for the SAML provider.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time when the SAML provider was created.

" + } + }, + "documentation":"

The list of SAML providers for this account.

" + }, + "SAMLProviderListType":{ + "type":"list", + "member":{"shape":"SAMLProviderListEntry"} + }, + "SAMLProviderNameType":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w._-]*" + }, + "ServerCertificate":{ + "type":"structure", + "required":[ + "ServerCertificateMetadata", + "CertificateBody" + ], + "members":{ + "ServerCertificateMetadata":{ + "shape":"ServerCertificateMetadata", + "documentation":"

The meta information of the server certificate, such as its name, path, ID, and ARN.

" + }, + "CertificateBody":{ + "shape":"certificateBodyType", + "documentation":"

The contents of the public key certificate.

" + }, + "CertificateChain":{ + "shape":"certificateChainType", + "documentation":"

The contents of the public key certificate chain.

" + } + }, + "documentation":"

The ServerCertificate data type contains information about a server certificate.

This data type is used as a response element in the action GetServerCertificate.

" + }, + "ServerCertificateMetadata":{ + "type":"structure", + "required":[ + "Path", + "ServerCertificateName", + "ServerCertificateId", + "Arn" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

Path to the server certificate. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name that identifies the server certificate.

" + }, + "ServerCertificateId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the server certificate. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "UploadDate":{ + "shape":"dateType", + "documentation":"

The date when the server certificate was uploaded.

" + }, + "Expiration":{ + "shape":"dateType", + "documentation":"

The date on which the certificate is set to expire.

" + } + }, + "documentation":"

ServerCertificateMetadata contains information about a server certificate without its certificate body, certificate chain, and private key.

This data type is used as a response element in the action UploadServerCertificate and ListServerCertificates.

" + }, + "SigningCertificate":{ + "type":"structure", + "required":[ + "UserName", + "CertificateId", + "CertificateBody", + "Status" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

Name of the user the signing certificate is associated with.

" + }, + "CertificateId":{ + "shape":"certificateIdType", + "documentation":"

The ID for the signing certificate.

" + }, + "CertificateBody":{ + "shape":"certificateBodyType", + "documentation":"

The contents of the signing certificate.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the signing certificate. Active means the key is valid for API calls, while Inactive means it is not.

" + }, + "UploadDate":{ + "shape":"dateType", + "documentation":"

The date when the signing certificate was uploaded.

" + } + }, + "documentation":"

The SigningCertificate data type contains information about an X.509 signing certificate.

This data type is used as a response element in the actions UploadSigningCertificate and ListSigningCertificates.

" + }, + "UpdateAccessKeyRequest":{ + "type":"structure", + "required":[ + "AccessKeyId", + "Status" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user whose key you want to update.

" + }, + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The access key ID of the secret access key you want to update.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status you want to assign to the secret access key. Active means the key can be used for API calls to AWS, while Inactive means the key cannot be used.

" + } + } + }, + "UpdateAccountPasswordPolicyRequest":{ + "type":"structure", + "members":{ + "MinimumPasswordLength":{ + "shape":"minimumPasswordLengthType", + "documentation":"

The minimum number of characters allowed in an IAM user password.

Default value: 6

" + }, + "RequireSymbols":{ + "shape":"booleanType", + "documentation":"Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ' Default value: false" + }, + "RequireNumbers":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

Default value: false

" + }, + "RequireUppercaseCharacters":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).

Default value: false

" + }, + "RequireLowercaseCharacters":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).

Default value: false

" + }, + "AllowUsersToChangePassword":{ + "shape":"booleanType", + "documentation":"

Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see Letting IAM Users Change Their Own Passwords in the Using IAM guide.

Default value: false

" + }, + "MaxPasswordAge":{ + "shape":"maxPasswordAgeType", + "documentation":"

The number of days that an IAM user password is valid. The default value of 0 means IAM user passwords never expire.

Default value: 0

" + }, + "PasswordReusePrevention":{ + "shape":"passwordReusePreventionType", + "documentation":"

Specifies the number of previous passwords that IAM users are prevented from reusing. The default value of 0 means IAM users are not prevented from reusing previous passwords.

Default value: 0

" + }, + "HardExpiry":{ + "shape":"booleanObjectType", + "documentation":"

Prevents IAM users from setting a new password after their password has expired.

Default value: false

" + } + } + }, + "UpdateAssumeRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyDocument" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

Name of the role to update.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy that grants an entity permission to assume the role.

" + } + } + }, + "UpdateGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the group to update. If you're changing the name of the group, this is the original name.

" + }, + "NewPath":{ + "shape":"pathType", + "documentation":"

New path for the group. Only include this if changing the group's path.

" + }, + "NewGroupName":{ + "shape":"groupNameType", + "documentation":"

New name for the group. Only include this if changing the group's name.

" + } + } + }, + "UpdateLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

Name of the user whose password you want to update.

" + }, + "Password":{ + "shape":"passwordType", + "documentation":"

The new password for the specified user.

" + }, + "PasswordResetRequired":{ + "shape":"booleanObjectType", + "documentation":"

Require the specified user to set a new password on next sign-in.

" + } + } + }, + "UpdateSAMLProviderRequest":{ + "type":"structure", + "required":[ + "SAMLMetadataDocument", + "SAMLProviderArn" + ], + "members":{ + "SAMLMetadataDocument":{ + "shape":"SAMLMetadataDocumentType", + "documentation":"

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

" + }, + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to update.

" + } + } + }, + "UpdateSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider that was updated.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the UpdateSAMLProvider action.

" + }, + "UpdateServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name of the server certificate that you want to update.

" + }, + "NewPath":{ + "shape":"pathType", + "documentation":"

The new path for the server certificate. Include this only if you are updating the server certificate's path.

" + }, + "NewServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The new name for the server certificate. Include this only if you are updating the server certificate's name.

" + } + } + }, + "UpdateSigningCertificateRequest":{ + "type":"structure", + "required":[ + "CertificateId", + "Status" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user the signing certificate belongs to.

" + }, + "CertificateId":{ + "shape":"certificateIdType", + "documentation":"

The ID of the signing certificate you want to update.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

" + } + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user to update. If you're changing the name of the user, this is the original user name.

" + }, + "NewPath":{ + "shape":"pathType", + "documentation":"

New path for the user. Include this parameter only if you're changing the user's path.

" + }, + "NewUserName":{ + "shape":"userNameType", + "documentation":"

New name for the user. Include this parameter only if you're changing the user's name.

" + } + } + }, + "UploadServerCertificateRequest":{ + "type":"structure", + "required":[ + "ServerCertificateName", + "CertificateBody", + "PrivateKey" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

" + }, + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name for the server certificate. Do not include the path in this value.

" + }, + "CertificateBody":{ + "shape":"certificateBodyType", + "documentation":"

The contents of the public key certificate in PEM-encoded format.

" + }, + "PrivateKey":{ + "shape":"privateKeyType", + "documentation":"

The contents of the private key in PEM-encoded format.

" + }, + "CertificateChain":{ + "shape":"certificateChainType", + "documentation":"

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

" + } + } + }, + "UploadServerCertificateResponse":{ + "type":"structure", + "members":{ + "ServerCertificateMetadata":{ + "shape":"ServerCertificateMetadata", + "documentation":"

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the UploadServerCertificate action.

" + }, + "UploadSigningCertificateRequest":{ + "type":"structure", + "required":["CertificateBody"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user the signing certificate is for.

" + }, + "CertificateBody":{ + "shape":"certificateBodyType", + "documentation":"

The contents of the signing certificate.

" + } + } + }, + "UploadSigningCertificateResponse":{ + "type":"structure", + "required":["Certificate"], + "members":{ + "Certificate":{ + "shape":"SigningCertificate", + "documentation":"

Information about the certificate.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the UploadSigningCertificate action.

" + }, + "User":{ + "type":"structure", + "required":[ + "Path", + "UserName", + "UserId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

Path to the user. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "UserName":{ + "shape":"userNameType", + "documentation":"

The name identifying the user.

" + }, + "UserId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the user was created.

" + } + }, + "documentation":"

The User data type contains information about a user.

This data type is used as a response element in the following actions:

" + }, + "VirtualMFADevice":{ + "type":"structure", + "required":["SerialNumber"], + "members":{ + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number associated with VirtualMFADevice.

" + }, + "Base32StringSeed":{ + "shape":"BootstrapDatum", + "documentation":"

The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.

" + }, + "QRCodePNG":{ + "shape":"BootstrapDatum", + "documentation":"

A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName? secret=$Base32String where $virtualMFADeviceName is one of the create call arguments, AccountName is the user name if set (accountId otherwise), and Base32String is the seed in Base32 format. The Base32String is Base64-encoded.

" + }, + "User":{"shape":"User"}, + "EnableDate":{"shape":"dateType"} + }, + "documentation":"

The VirtualMFADevice data type contains information about a virtual MFA device.

" + }, + "accessKeyIdType":{ + "type":"string", + "min":16, + "max":32, + "pattern":"[\\w]*" + }, + "accessKeyMetadataListType":{ + "type":"list", + "member":{"shape":"AccessKeyMetadata"}, + "documentation":"

The accessKeyMetadataListType data type contains a list of access key metadata.

This data type is used as a response element in the action ListAccessKeys.

" + }, + "accessKeySecretType":{ + "type":"string", + "sensitive":true + }, + "accountAliasListType":{ + "type":"list", + "member":{"shape":"accountAliasType"} + }, + "accountAliasType":{ + "type":"string", + "min":3, + "max":63, + "pattern":"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$" + }, + "arnType":{ + "type":"string", + "min":20, + "max":2048 + }, + "assignmentStatusType":{ + "type":"string", + "enum":[ + "Assigned", + "Unassigned", + "Any" + ] + }, + "authenticationCodeType":{ + "type":"string", + "min":6, + "max":6, + "pattern":"[\\d]*" + }, + "booleanObjectType":{ + "type":"boolean", + "box":true + }, + "booleanType":{"type":"boolean"}, + "certificateBodyType":{ + "type":"string", + "min":1, + "max":16384, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "certificateChainType":{ + "type":"string", + "min":1, + "max":2097152, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*" + }, + "certificateIdType":{ + "type":"string", + "min":24, + "max":128, + "pattern":"[\\w]*" + }, + "certificateListType":{ + "type":"list", + "member":{"shape":"SigningCertificate"}, + "documentation":"

The certificateListType data type contains a list of signing certificates.

This data type is used as a response element in the action ListSigningCertificates.

" + }, + "credentialReportExpiredExceptionMessage":{"type":"string"}, + "credentialReportNotPresentExceptionMessage":{"type":"string"}, + "credentialReportNotReadyExceptionMessage":{"type":"string"}, + "dateType":{"type":"timestamp"}, + "deleteConflictMessage":{"type":"string"}, + "duplicateCertificateMessage":{"type":"string"}, + "entityAlreadyExistsMessage":{"type":"string"}, + "entityTemporarilyUnmodifiableMessage":{"type":"string"}, + "existingUserNameType":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w+=,.@-]*" + }, + "groupListType":{ + "type":"list", + "member":{"shape":"Group"}, + "documentation":"

The groupListType data type contains a list of groups.

This data type is used as a response element in the action ListGroups.

" + }, + "groupNameType":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w+=,.@-]*" + }, + "idType":{ + "type":"string", + "min":16, + "max":32, + "pattern":"[\\w]*" + }, + "instanceProfileListType":{ + "type":"list", + "member":{"shape":"InstanceProfile"}, + "documentation":"

The instanceProfileListType data type contains a list of instance profiles.

This data type is used as a response element in the actions ListInstanceProfiles and ListInstanceProfilesForRole.

" + }, + "instanceProfileNameType":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w+=,.@-]*" + }, + "invalidAuthenticationCodeMessage":{"type":"string"}, + "invalidCertificateMessage":{"type":"string"}, + "invalidInputMessage":{"type":"string"}, + "invalidUserTypeMessage":{"type":"string"}, + "keyPairMismatchMessage":{"type":"string"}, + "limitExceededMessage":{"type":"string"}, + "malformedCertificateMessage":{"type":"string"}, + "malformedPolicyDocumentMessage":{"type":"string"}, + "markerType":{ + "type":"string", + "min":1, + "max":320, + "pattern":"[\\u0020-\\u00FF]*" + }, + "maxItemsType":{ + "type":"integer", + "min":1, + "max":1000 + }, + "maxPasswordAgeType":{ + "type":"integer", + "min":1, + "max":1095, + "box":true + }, + "mfaDeviceListType":{ + "type":"list", + "member":{"shape":"MFADevice"}, + "documentation":"

Contains a list of MFA devices.

This data type is used as a response element in the actions ListMFADevices and ListVirtualMFADevices.

" + }, + "minimumPasswordLengthType":{ + "type":"integer", + "min":6, + "max":128 + }, + "noSuchEntityMessage":{"type":"string"}, + "passwordPolicyViolationMessage":{"type":"string"}, + "passwordReusePreventionType":{ + "type":"integer", + "min":1, + "max":24, + "box":true + }, + "passwordType":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "sensitive":true + }, + "pathPrefixType":{ + "type":"string", + "min":1, + "max":512, + "pattern":"\\u002F[\\u0021-\\u007F]*" + }, + "pathType":{ + "type":"string", + "min":1, + "max":512, + "pattern":"(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)" + }, + "policyDocumentType":{ + "type":"string", + "min":1, + "max":131072, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "policyNameListType":{ + "type":"list", + "member":{"shape":"policyNameType"}, + "documentation":"

The policyNameListType data type contains a list of policy names.

This data type is used as a response element in the action ListPolicies.

" + }, + "policyNameType":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w+=,.@-]*" + }, + "privateKeyType":{ + "type":"string", + "min":1, + "max":16384, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*", + "sensitive":true + }, + "roleListType":{ + "type":"list", + "member":{"shape":"Role"}, + "documentation":"

The roleListType data type contains a list of roles.

This data type is used as a response element in the action ListRoles.

" + }, + "roleNameType":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[\\w+=,.@-]*" + }, + "serialNumberType":{ + "type":"string", + "min":9, + "max":256, + "pattern":"[\\w+=/:,.@-]*" + }, + "serverCertificateMetadataListType":{ + "type":"list", + "member":{"shape":"ServerCertificateMetadata"} + }, + "serverCertificateNameType":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w+=,.@-]*" + }, + "statusType":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "summaryKeyType":{ + "type":"string", + "enum":[ + "Users", + "UsersQuota", + "Groups", + "GroupsQuota", + "ServerCertificates", + "ServerCertificatesQuota", + "UserPolicySizeQuota", + "GroupPolicySizeQuota", + "GroupsPerUserQuota", + "SigningCertificatesPerUserQuota", + "AccessKeysPerUserQuota", + "MFADevices", + "MFADevicesInUse", + "AccountMFAEnabled" + ] + }, + "summaryMapType":{ + "type":"map", + "key":{"shape":"summaryKeyType"}, + "value":{"shape":"summaryValueType"} + }, + "summaryValueType":{"type":"integer"}, + "userListType":{ + "type":"list", + "member":{"shape":"User"}, + "documentation":"

The userListType data type contains a list of users.

This data type is used as a response element in the actions GetGroup and ListUsers.

" + }, + "userNameType":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[\\w+=,.@-]*" + }, + "virtualMFADeviceListType":{ + "type":"list", + "member":{"shape":"VirtualMFADevice"} + }, + "virtualMFADeviceName":{ + "type":"string", + "min":1, + "pattern":"[\\w+=,.@-]*" + } + } +} diff --git a/apis/iam-2010-05-08.paginators.json b/apis/iam-2010-05-08.paginators.json new file mode 100644 index 0000000000..3dd3683c73 --- /dev/null +++ b/apis/iam-2010-05-08.paginators.json @@ -0,0 +1,119 @@ +{ + "pagination": { + "GetGroup": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "Users" + }, + "ListAccessKeys": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "AccessKeyMetadata" + }, + "ListAccountAliases": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "AccountAliases" + }, + "ListGroupPolicies": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "PolicyNames" + }, + "ListGroups": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "Groups" + }, + "ListGroupsForUser": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "Groups" + }, + "ListInstanceProfiles": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "InstanceProfiles" + }, + "ListInstanceProfilesForRole": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "InstanceProfiles" + }, + "ListMFADevices": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "MFADevices" + }, + "ListRolePolicies": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "PolicyNames" + }, + "ListRoles": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "Roles" + }, + "ListSAMLProviders": { + "result_key": "SAMLProviderList" + }, + "ListServerCertificates": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "ServerCertificateMetadataList" + }, + "ListSigningCertificates": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "Certificates" + }, + "ListUserPolicies": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "PolicyNames" + }, + "ListUsers": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "Users" + }, + "ListVirtualMFADevices": { + "input_token": "Marker", + "output_token": "Marker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "VirtualMFADevices" + } + } +} diff --git a/apis/importexport-2010-06-01.api.json b/apis/importexport-2010-06-01.api.json new file mode 100644 index 0000000000..1a94d67855 --- /dev/null +++ b/apis/importexport-2010-06-01.api.json @@ -0,0 +1,181 @@ +{ + "metadata": { + "apiVersion": "2010-06-01", + "endpointPrefix": "importexport", + "globalEndpoint": "importexport.amazonaws.com", + "serviceFullName": "AWS Import/Export", + "signatureVersion": "v2", + "xmlNamespace": "http://importexport.amazonaws.com/doc/2010-06-01/", + "protocol": "query" + }, + "operations": { + "CancelJob": { + "http": { + "requestUri": "/?Operation=CancelJob" + }, + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "resultWrapper": "CancelJobResult", + "type": "structure", + "members": { + "Success": { + "type": "boolean" + } + } + } + }, + "CreateJob": { + "http": { + "requestUri": "/?Operation=CreateJob" + }, + "input": { + "type": "structure", + "required": [ + "JobType", + "Manifest", + "ValidateOnly" + ], + "members": { + "JobType": {}, + "Manifest": {}, + "ManifestAddendum": {}, + "ValidateOnly": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "CreateJobResult", + "type": "structure", + "members": { + "JobId": {}, + "JobType": {}, + "AwsShippingAddress": {}, + "Signature": {}, + "SignatureFileContents": {}, + "WarningMessage": {} + } + } + }, + "GetStatus": { + "http": { + "requestUri": "/?Operation=GetStatus" + }, + "input": { + "type": "structure", + "required": [ + "JobId" + ], + "members": { + "JobId": {} + } + }, + "output": { + "resultWrapper": "GetStatusResult", + "type": "structure", + "members": { + "JobId": {}, + "JobType": {}, + "AwsShippingAddress": {}, + "LocationCode": {}, + "LocationMessage": {}, + "ProgressCode": {}, + "ProgressMessage": {}, + "Carrier": {}, + "TrackingNumber": {}, + "LogBucket": {}, + "LogKey": {}, + "ErrorCount": { + "type": "integer" + }, + "Signature": {}, + "SignatureFileContents": {}, + "CurrentManifest": {}, + "CreationDate": { + "type": "timestamp" + } + } + } + }, + "ListJobs": { + "http": { + "requestUri": "/?Operation=ListJobs" + }, + "input": { + "type": "structure", + "members": { + "MaxJobs": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "ListJobsResult", + "type": "structure", + "members": { + "Jobs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "JobId": {}, + "CreationDate": { + "type": "timestamp" + }, + "IsCanceled": { + "type": "boolean" + }, + "JobType": {} + } + } + }, + "IsTruncated": { + "type": "boolean" + } + } + } + }, + "UpdateJob": { + "http": { + "requestUri": "/?Operation=UpdateJob" + }, + "input": { + "type": "structure", + "required": [ + "JobId", + "Manifest", + "JobType", + "ValidateOnly" + ], + "members": { + "JobId": {}, + "Manifest": {}, + "JobType": {}, + "ValidateOnly": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "UpdateJobResult", + "type": "structure", + "members": { + "Success": { + "type": "boolean" + }, + "WarningMessage": {} + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/apis/importexport-2010-06-01.full.json b/apis/importexport-2010-06-01.full.json new file mode 100644 index 0000000000..9528f8c997 --- /dev/null +++ b/apis/importexport-2010-06-01.full.json @@ -0,0 +1,687 @@ +{ + "metadata":{ + "apiVersion":"2010-06-01", + "endpointPrefix":"importexport", + "globalEndpoint":"importexport.amazonaws.com", + "serviceFullName":"AWS Import/Export", + "signatureVersion":"v2", + "xmlNamespace":"http://importexport.amazonaws.com/doc/2010-06-01/", + "protocol":"query" + }, + "documentation":"AWS Import/Export Service\n AWS Import/Export accelerates transferring large amounts of data between\n the AWS cloud and portable storage devices that you mail to us. AWS\n Import/Export transfers data directly onto and off of your storage devices\n using Amazon's high-speed internal network and bypassing the Internet. For\n large data sets, AWS Import/Export is often faster than Internet transfer\n and more cost effective than upgrading your connectivity.", + "operations":{ + "CancelJob":{ + "name":"CancelJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=CancelJob" + }, + "input":{ + "shape":"CancelJobInput", + "documentation":"Input structure for the CancelJob operation." + }, + "output":{ + "shape":"CancelJobOutput", + "documentation":"Output structure for the CancelJob operation.", + "resultWrapper":"CancelJobResult" + }, + "errors":[ + { + "shape":"InvalidJobIdException", + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + { + "shape":"ExpiredJobIdException", + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + { + "shape":"CanceledJobIdException", + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + { + "shape":"UnableToCancelJobIdException", + "exception":true, + "documentation":"AWS Import/Export cannot cancel the job" + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID." + } + ], + "documentation":"This operation cancels a specified job. Only the job owner can cancel it.\n The operation fails if the job has already started or is complete." + }, + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=CreateJob" + }, + "input":{ + "shape":"CreateJobInput", + "documentation":"Input structure for the CreateJob operation." + }, + "output":{ + "shape":"CreateJobOutput", + "documentation":"Output structure for the CreateJob operation.", + "resultWrapper":"CreateJobResult" + }, + "errors":[ + { + "shape":"MissingParameterException", + "exception":true, + "documentation":"One or more required parameters was missing from the request." + }, + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID." + }, + { + "shape":"InvalidAddressException", + "exception":true, + "documentation":"The address specified in the manifest is invalid." + }, + { + "shape":"InvalidManifestFieldException", + "exception":true, + "documentation":"One or more manifest fields was invalid. Please correct and resubmit." + }, + { + "shape":"MissingManifestFieldException", + "exception":true, + "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." + }, + { + "shape":"NoSuchBucketException", + "exception":true, + "documentation":"The specified bucket does not exist. Create the specified bucket or change\n the manifest's bucket, exportBucket, or logBucket field to a bucket that\n the account, as specified by the manifest's Access Key ID, has write\n permissions to." + }, + { + "shape":"MissingCustomsException", + "exception":true, + "documentation":"One or more required customs parameters was missing from the manifest." + }, + { + "shape":"InvalidCustomsException", + "exception":true, + "documentation":"One or more customs parameters was invalid. Please correct and resubmit." + }, + { + "shape":"InvalidFileSystemException", + "exception":true, + "documentation":"File system specified in export manifest is invalid." + }, + { + "shape":"MultipleRegionsException", + "exception":true, + "documentation":"Your manifest file contained buckets from multiple regions. A job is\n restricted to buckets from one region. Please correct and resubmit." + }, + { + "shape":"BucketPermissionException", + "exception":true, + "documentation":"The account specified does not have the appropriate bucket permissions." + }, + { + "shape":"MalformedManifestException", + "exception":true, + "documentation":"Your manifest is not well-formed." + } + ], + "documentation":"This operation initiates the process of scheduling an upload or download of\n your data. You include in the request a manifest that describes the data\n transfer specifics. The response to the request includes a job ID, which\n you can use in other operations, a signature that you use to identify your\n storage device, and the address where you should ship your storage device." + }, + "GetStatus":{ + "name":"GetStatus", + "http":{ + "method":"POST", + "requestUri":"/?Operation=GetStatus" + }, + "input":{ + "shape":"GetStatusInput", + "documentation":"Input structure for the GetStatus operation." + }, + "output":{ + "shape":"GetStatusOutput", + "documentation":"Output structure for the GetStatus operation.", + "resultWrapper":"GetStatusResult" + }, + "errors":[ + { + "shape":"InvalidJobIdException", + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + { + "shape":"ExpiredJobIdException", + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + { + "shape":"CanceledJobIdException", + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID." + } + ], + "documentation":"This operation returns information about a job, including where the job is\n in the processing pipeline, the status of the results, and the signature\n value associated with the job. You can only return information about jobs\n you own." + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"POST", + "requestUri":"/?Operation=ListJobs" + }, + "input":{ + "shape":"ListJobsInput", + "documentation":"Input structure for the ListJobs operation." + }, + "output":{ + "shape":"ListJobsOutput", + "documentation":"Output structure for the ListJobs operation.", + "resultWrapper":"ListJobsResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID." + } + ], + "documentation":"This operation returns the jobs associated with the requester. AWS\n Import/Export lists the jobs in reverse chronological order based on the\n date of creation. For example if Job Test1 was created 2009Dec30 and Test2\n was created 2010Feb05, the ListJobs operation would return Test2 followed\n by Test1." + }, + "UpdateJob":{ + "name":"UpdateJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=UpdateJob" + }, + "input":{ + "shape":"UpdateJobInput", + "documentation":"Input structure for the UpateJob operation." + }, + "output":{ + "shape":"UpdateJobOutput", + "documentation":"Output structure for the UpateJob operation.", + "resultWrapper":"UpdateJobResult" + }, + "errors":[ + { + "shape":"MissingParameterException", + "exception":true, + "documentation":"One or more required parameters was missing from the request." + }, + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID." + }, + { + "shape":"InvalidAddressException", + "exception":true, + "documentation":"The address specified in the manifest is invalid." + }, + { + "shape":"InvalidManifestFieldException", + "exception":true, + "documentation":"One or more manifest fields was invalid. Please correct and resubmit." + }, + { + "shape":"InvalidJobIdException", + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + { + "shape":"MissingManifestFieldException", + "exception":true, + "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." + }, + { + "shape":"NoSuchBucketException", + "exception":true, + "documentation":"The specified bucket does not exist. Create the specified bucket or change\n the manifest's bucket, exportBucket, or logBucket field to a bucket that\n the account, as specified by the manifest's Access Key ID, has write\n permissions to." + }, + { + "shape":"ExpiredJobIdException", + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + { + "shape":"CanceledJobIdException", + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + { + "shape":"MissingCustomsException", + "exception":true, + "documentation":"One or more required customs parameters was missing from the manifest." + }, + { + "shape":"InvalidCustomsException", + "exception":true, + "documentation":"One or more customs parameters was invalid. Please correct and resubmit." + }, + { + "shape":"InvalidFileSystemException", + "exception":true, + "documentation":"File system specified in export manifest is invalid." + }, + { + "shape":"MultipleRegionsException", + "exception":true, + "documentation":"Your manifest file contained buckets from multiple regions. A job is\n restricted to buckets from one region. Please correct and resubmit." + }, + { + "shape":"BucketPermissionException", + "exception":true, + "documentation":"The account specified does not have the appropriate bucket permissions." + }, + { + "shape":"MalformedManifestException", + "exception":true, + "documentation":"Your manifest is not well-formed." + } + ], + "documentation":"You use this operation to change the parameters specified in the original\n manifest file by supplying a new manifest file. The manifest file attached\n to this request replaces the original manifest file. You can only use the\n operation after a CreateJob request but before the data transfer starts and\n you can only use it on jobs you own." + } + }, + "shapes":{ + "AwsShippingAddress":{ + "type":"string", + "documentation":"Address you ship your storage device to." + }, + "BucketPermissionException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The account specified does not have the appropriate bucket permissions." + }, + "CancelJobInput":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"} + }, + "documentation":"Input structure for the CancelJob operation." + }, + "CancelJobOutput":{ + "type":"structure", + "members":{ + "Success":{"shape":"Success"} + }, + "documentation":"Output structure for the CancelJob operation." + }, + "CanceledJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + "Carrier":{ + "type":"string", + "documentation":"Name of the shipping company. This value is included when the LocationCode is \"Returned\"." + }, + "CreateJobInput":{ + "type":"structure", + "required":[ + "JobType", + "Manifest", + "ValidateOnly" + ], + "members":{ + "JobType":{"shape":"JobType"}, + "Manifest":{"shape":"Manifest"}, + "ManifestAddendum":{"shape":"ManifestAddendum"}, + "ValidateOnly":{"shape":"ValidateOnly"} + }, + "documentation":"Input structure for the CreateJob operation." + }, + "CreateJobOutput":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobType":{"shape":"JobType"}, + "AwsShippingAddress":{"shape":"AwsShippingAddress"}, + "Signature":{"shape":"Signature"}, + "SignatureFileContents":{"shape":"SignatureFileContents"}, + "WarningMessage":{"shape":"WarningMessage"} + }, + "documentation":"Output structure for the CreateJob operation." + }, + "CreationDate":{ + "type":"timestamp", + "documentation":"Timestamp of the CreateJob request in ISO8601 date format. For example \"2010-03-28T20:27:35Z\"." + }, + "CurrentManifest":{ + "type":"string", + "documentation":"The last manifest submitted, which will be used to process the job." + }, + "ErrorCount":{ + "type":"integer", + "documentation":"Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors." + }, + "ErrorMessage":{ + "type":"string", + "documentation":"The human-readable description of a particular error." + }, + "ExpiredJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + "GetStatusInput":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"} + }, + "documentation":"Input structure for the GetStatus operation." + }, + "GetStatusOutput":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobType":{"shape":"JobType"}, + "AwsShippingAddress":{"shape":"AwsShippingAddress"}, + "LocationCode":{"shape":"LocationCode"}, + "LocationMessage":{"shape":"LocationMessage"}, + "ProgressCode":{"shape":"ProgressCode"}, + "ProgressMessage":{"shape":"ProgressMessage"}, + "Carrier":{"shape":"Carrier"}, + "TrackingNumber":{"shape":"TrackingNumber"}, + "LogBucket":{"shape":"LogBucket"}, + "LogKey":{"shape":"LogKey"}, + "ErrorCount":{"shape":"ErrorCount"}, + "Signature":{"shape":"Signature"}, + "SignatureFileContents":{"shape":"Signature"}, + "CurrentManifest":{"shape":"CurrentManifest"}, + "CreationDate":{"shape":"CreationDate"} + }, + "documentation":"Output structure for the GetStatus operation." + }, + "InvalidAccessKeyIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID." + }, + "InvalidAddressException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The address specified in the manifest is invalid." + }, + "InvalidCustomsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more customs parameters was invalid. Please correct and resubmit." + }, + "InvalidFileSystemException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"File system specified in export manifest is invalid." + }, + "InvalidJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + "InvalidManifestFieldException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more manifest fields was invalid. Please correct and resubmit." + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + "IsCanceled":{ + "type":"boolean", + "documentation":"Indicates whether the job was canceled." + }, + "IsTruncated":{ + "type":"boolean", + "documentation":"Indicates whether the list of jobs was truncated. If true, then call\n ListJobs again using the last JobId element as the marker." + }, + "Job":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "CreationDate":{"shape":"CreationDate"}, + "IsCanceled":{"shape":"IsCanceled"}, + "JobType":{"shape":"JobType"} + }, + "documentation":"Representation of a job returned by the ListJobs operation." + }, + "JobId":{ + "type":"string", + "documentation":"A unique identifier which refers to a particular job." + }, + "JobType":{ + "type":"string", + "enum":[ + "Import", + "Export" + ], + "documentation":"Specifies whether the job to initiate is an import or export job." + }, + "JobsList":{ + "type":"list", + "member":{"shape":"Job"}, + "documentation":"A list container for Jobs returned by the ListJobs operation." + }, + "ListJobsInput":{ + "type":"structure", + "members":{ + "MaxJobs":{"shape":"MaxJobs"}, + "Marker":{"shape":"Marker"} + }, + "documentation":"Input structure for the ListJobs operation." + }, + "ListJobsOutput":{ + "type":"structure", + "members":{ + "Jobs":{"shape":"JobsList"}, + "IsTruncated":{"shape":"IsTruncated"} + }, + "documentation":"Output structure for the ListJobs operation." + }, + "LocationCode":{ + "type":"string", + "documentation":"A token representing the location of the storage device, such as \"AtAWS\"." + }, + "LocationMessage":{ + "type":"string", + "documentation":"A more human readable form of the physical location of the storage device." + }, + "LogBucket":{ + "type":"string", + "documentation":"Amazon S3 bucket for user logs." + }, + "LogKey":{ + "type":"string", + "documentation":"The key where the user logs were stored." + }, + "MalformedManifestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"Your manifest is not well-formed." + }, + "Manifest":{ + "type":"string", + "documentation":"The UTF-8 encoded text of the manifest file." + }, + "ManifestAddendum":{ + "type":"string", + "documentation":"For internal use only." + }, + "Marker":{ + "type":"string", + "documentation":"Specifies the JOBID to start after when listing the jobs created with your\n account. AWS Import/Export lists your jobs in reverse chronological order.\n See MaxJobs." + }, + "MaxJobs":{ + "type":"integer", + "documentation":"Sets the maximum number of jobs returned in the response. If there are\n additional jobs that were not returned because MaxJobs was exceeded, the\n response contains <IsTruncated>true</IsTruncated>. To return\n the additional jobs, see Marker." + }, + "MissingCustomsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more required customs parameters was missing from the manifest." + }, + "MissingManifestFieldException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." + }, + "MissingParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more required parameters was missing from the request." + }, + "MultipleRegionsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"Your manifest file contained buckets from multiple regions. A job is\n restricted to buckets from one region. Please correct and resubmit." + }, + "NoSuchBucketException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The specified bucket does not exist. Create the specified bucket or change\n the manifest's bucket, exportBucket, or logBucket field to a bucket that\n the account, as specified by the manifest's Access Key ID, has write\n permissions to." + }, + "ProgressCode":{ + "type":"string", + "documentation":"A token representing the state of the job, such as \"Started\"." + }, + "ProgressMessage":{ + "type":"string", + "documentation":"A more human readable form of the job status." + }, + "Signature":{ + "type":"string", + "documentation":"An encrypted code used to authenticate the request and response, for\n example, \"DV+TpDfx1/TdSE9ktyK9k/bDTVI=\". Only use this value is you want to\n create the signature file yourself. Generally you should use the\n SignatureFileContents value." + }, + "SignatureFileContents":{ + "type":"string", + "documentation":"The actual text of the SIGNATURE file to be written to disk." + }, + "Success":{ + "type":"boolean", + "documentation":"Specifies whether (true) or not (false) AWS Import/Export updated your job." + }, + "TrackingNumber":{ + "type":"string", + "documentation":"The shipping tracking number assigned by AWS Import/Export to the storage\n device when it's returned to you. We return this value when the\n LocationCode is \"Returned\"." + }, + "UnableToCancelJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"AWS Import/Export cannot cancel the job" + }, + "UpdateJobInput":{ + "type":"structure", + "required":[ + "JobId", + "Manifest", + "JobType", + "ValidateOnly" + ], + "members":{ + "JobId":{"shape":"JobId"}, + "Manifest":{"shape":"Manifest"}, + "JobType":{"shape":"JobType"}, + "ValidateOnly":{"shape":"ValidateOnly"} + }, + "documentation":"Input structure for the UpateJob operation." + }, + "UpdateJobOutput":{ + "type":"structure", + "members":{ + "Success":{"shape":"Success"}, + "WarningMessage":{"shape":"WarningMessage"} + }, + "documentation":"Output structure for the UpateJob operation." + }, + "ValidateOnly":{ + "type":"boolean", + "documentation":"Validate the manifest and parameter values in the request but do not actually create a job." + }, + "WarningMessage":{ + "type":"string", + "documentation":"An optional message notifying you of non-fatal issues with the job, such as\n use of an incompatible Amazon S3 bucket name." + } + } +} diff --git a/apis/importexport-2010-06-01.paginators.json b/apis/importexport-2010-06-01.paginators.json new file mode 100644 index 0000000000..702385ea6f --- /dev/null +++ b/apis/importexport-2010-06-01.paginators.json @@ -0,0 +1,11 @@ +{ + "pagination": { + "ListJobs": { + "input_token": "Marker", + "output_token": "Jobs[-1].JobId", + "more_results": "IsTruncated", + "limit_key": "MaxJobs", + "result_key": "Jobs" + } + } +} diff --git a/apis/kinesis-2013-12-02.api.json b/apis/kinesis-2013-12-02.api.json new file mode 100644 index 0000000000..be0b407f02 --- /dev/null +++ b/apis/kinesis-2013-12-02.api.json @@ -0,0 +1,342 @@ +{ + "metadata": { + "apiVersion": "2013-12-02", + "endpointPrefix": "kinesis", + "jsonVersion": "1.1", + "serviceAbbreviation": "Kinesis", + "serviceFullName": "Amazon Kinesis", + "signatureVersion": "v4", + "targetPrefix": "Kinesis_20131202", + "protocol": "json" + }, + "operations": { + "AddTagsToStream": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "Tags" + ], + "members": { + "StreamName": {}, + "Tags": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "CreateStream": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardCount" + ], + "members": { + "StreamName": {}, + "ShardCount": { + "type": "integer" + } + } + } + }, + "DeleteStream": { + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "StreamName": {} + } + } + }, + "DescribeStream": { + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "StreamName": {}, + "Limit": { + "type": "integer" + }, + "ExclusiveStartShardId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "StreamDescription" + ], + "members": { + "StreamDescription": { + "type": "structure", + "required": [ + "StreamName", + "StreamARN", + "StreamStatus", + "Shards", + "HasMoreShards" + ], + "members": { + "StreamName": {}, + "StreamARN": {}, + "StreamStatus": {}, + "Shards": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ShardId", + "HashKeyRange", + "SequenceNumberRange" + ], + "members": { + "ShardId": {}, + "ParentShardId": {}, + "AdjacentParentShardId": {}, + "HashKeyRange": { + "type": "structure", + "required": [ + "StartingHashKey", + "EndingHashKey" + ], + "members": { + "StartingHashKey": {}, + "EndingHashKey": {} + } + }, + "SequenceNumberRange": { + "type": "structure", + "required": [ + "StartingSequenceNumber" + ], + "members": { + "StartingSequenceNumber": {}, + "EndingSequenceNumber": {} + } + } + } + } + }, + "HasMoreShards": { + "type": "boolean" + } + } + } + } + } + }, + "GetRecords": { + "input": { + "type": "structure", + "required": [ + "ShardIterator" + ], + "members": { + "ShardIterator": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Records" + ], + "members": { + "Records": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SequenceNumber", + "Data", + "PartitionKey" + ], + "members": { + "SequenceNumber": {}, + "Data": { + "type": "blob" + }, + "PartitionKey": {} + } + } + }, + "NextShardIterator": {} + } + } + }, + "GetShardIterator": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardId", + "ShardIteratorType" + ], + "members": { + "StreamName": {}, + "ShardId": {}, + "ShardIteratorType": {}, + "StartingSequenceNumber": {} + } + }, + "output": { + "type": "structure", + "members": { + "ShardIterator": {} + } + } + }, + "ListStreams": { + "input": { + "type": "structure", + "members": { + "Limit": { + "type": "integer" + }, + "ExclusiveStartStreamName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "StreamNames", + "HasMoreStreams" + ], + "members": { + "StreamNames": { + "type": "list", + "member": {} + }, + "HasMoreStreams": { + "type": "boolean" + } + } + } + }, + "ListTagsForStream": { + "input": { + "type": "structure", + "required": [ + "StreamName" + ], + "members": { + "StreamName": {}, + "ExclusiveStartTagKey": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Tags", + "HasMoreTags" + ], + "members": { + "Tags": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "HasMoreTags": { + "type": "boolean" + } + } + } + }, + "MergeShards": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardToMerge", + "AdjacentShardToMerge" + ], + "members": { + "StreamName": {}, + "ShardToMerge": {}, + "AdjacentShardToMerge": {} + } + } + }, + "PutRecord": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "Data", + "PartitionKey" + ], + "members": { + "StreamName": {}, + "Data": { + "type": "blob" + }, + "PartitionKey": {}, + "ExplicitHashKey": {}, + "SequenceNumberForOrdering": {} + } + }, + "output": { + "type": "structure", + "required": [ + "ShardId", + "SequenceNumber" + ], + "members": { + "ShardId": {}, + "SequenceNumber": {} + } + } + }, + "RemoveTagsFromStream": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "TagKeys" + ], + "members": { + "StreamName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "SplitShard": { + "input": { + "type": "structure", + "required": [ + "StreamName", + "ShardToSplit", + "NewStartingHashKey" + ], + "members": { + "StreamName": {}, + "ShardToSplit": {}, + "NewStartingHashKey": {} + } + } + } + }, + "shapes": {} +} \ No newline at end of file diff --git a/apis/kinesis-2013-12-02.full.json b/apis/kinesis-2013-12-02.full.json new file mode 100644 index 0000000000..5822747cc2 --- /dev/null +++ b/apis/kinesis-2013-12-02.full.json @@ -0,0 +1,1041 @@ +{ + "metadata":{ + "apiVersion":"2013-12-02", + "endpointPrefix":"kinesis", + "jsonVersion":"1.1", + "serviceAbbreviation":"Kinesis", + "serviceFullName":"Amazon Kinesis", + "signatureVersion":"v4", + "targetPrefix":"Kinesis_20131202", + "protocol":"json" + }, + "documentation":"Amazon Kinesis Service API Reference

Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.

", + "operations":{ + "AddTagsToStream":{ + "name":"AddTagsToStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddTagsToStreamInput", + "documentation":"

Represents the input for AddTagsToStream.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + } + ], + "documentation":"

Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

" + }, + "CreateStream":{ + "name":"CreateStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateStreamInput", + "documentation":"

Represents the input for CreateStream.

" + }, + "errors":[ + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + } + ], + "documentation":"

Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.

You specify and control the number of shards that a stream is composed of. Each open shard can support up to 5 read transactions per second, up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 write transactions per second, up to a maximum total of 1 MB data written per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.

The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.

CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets the stream status to CREATING. After the stream is created, Amazon Kinesis sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.

You receive a LimitExceededException when making a CreateStream request if you try to do one of the following:

The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.

You can use DescribeStream to check the stream status, which is returned in StreamStatus.

CreateStream has a limit of 5 transactions per second per account.

" + }, + "DeleteStream":{ + "name":"DeleteStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteStreamInput", + "documentation":"

Represents the input for DeleteStream.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + } + ], + "documentation":"

Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception ResourceNotFoundException.

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Amazon Kinesis completes the deletion.

Note: Amazon Kinesis might continue to accept data read and write operations, such as PutRecord and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream has a limit of 5 transactions per second per account.

" + }, + "DescribeStream":{ + "name":"DescribeStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeStreamInput", + "documentation":"

Represents the input for DescribeStream.

" + }, + "output":{ + "shape":"DescribeStreamOutput", + "documentation":"

Represents the output for DescribeStream.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + } + ], + "documentation":"

Describes the specified stream.

The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.

You can limit the number of returned shards using the Limit parameter. The number of shards in a stream may be too large to return from a single call to DescribeStream. You can detect this by using the HasMoreShards flag in the returned output. HasMoreShards is set to true when there is more data available.

DescribeStream is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the ExclusiveStartShardId parameter in a subsequent request to DescribeStream.

DescribeStream has a limit of 10 transactions per second per account.

" + }, + "GetRecords":{ + "name":"GetRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetRecordsInput", + "documentation":"

Represents the input for GetRecords.

" + }, + "output":{ + "shape":"GetRecordsOutput", + "documentation":"

Represents the output for GetRecords.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.

" + }, + { + "shape":"ExpiredIteratorException", + "exception":true, + "documentation":"

The provided iterator exceeds the maximum age allowed.

" + } + ], + "documentation":"

Gets data records from a shard.

You specify a shard iterator for the shard using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. GetRecords returns a new shard iterator in NextShardIterator. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. To read from an Amazon Kinesis stream continually, use GetShardIterator to get the shard iterator to specify in the first GetRecords call, and then specify the shard iterator returned in NextShardIterator in subsequent calls.

If there are no records available, GetRecords returns an empty list.

The size of the data returned by GetRecords will vary, but the maximum size is 10 MB. Each data record can be up to 50 KB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when specifying a limit. For example, if your average record size is 40 KB, you can limit the data returned to about 1 MB per call using a limit of 25.

If there is insufficient provisioned throughput on the shard involved in the request, subsequent calls to GetRecords made within the next one second throw ProvisionedThroughputExceededException. GetRecords won't return data when it throws an exception, so wait one second before making another call or the application won't get any records. Also, you can scale by provisioning multiple shards.

To detect whether you are falling behind in processing, add a timestamp to your records and note how long it takes to process them.

" + }, + "GetShardIterator":{ + "name":"GetShardIterator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetShardIteratorInput", + "documentation":"

Represents the input for GetShardIterator.

" + }, + "output":{ + "shape":"GetShardIteratorOutput", + "documentation":"

Represents the output for GetShardIterator.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.

" + } + ], + "documentation":"

Gets a shard iterator in ShardIterator. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.

You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type, or right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier PutRecord, GetRecords or DescribeStream requests. You can specify the shard iterator type TRIM_HORIZON in the request to cause ShardIterator to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type LATEST, so that you always read the most recent data in the shard.

Note: Each shard iterator expires five minutes after it is returned to the requester.

When you repeatedly read from an Amazon Kinesis stream use a GetShardIterator request to get the first shard iterator to to use in your first GetRecords request and then use the shard iterator returned by the GetRecords request in NextShardIterator for subsequent reads. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you will receive a ProvisionedThroughputExceededException. For more information about throughput limits, see the Amazon Kinesis Developer Guide.

GetShardIterator can return null for its ShardIterator to indicate that the shard has been closed and that the requested iterator will return no more data. A shard can be closed by SplitShard or MergeShards.

GetShardIterator has a limit of 5 transactions per second per account per open shard.

" + }, + "ListStreams":{ + "name":"ListStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListStreamsInput", + "documentation":"

Represents the input for ListStreams.

" + }, + "output":{ + "shape":"ListStreamsOutput", + "documentation":"

Represents the output for ListStreams.

" + }, + "errors":[ + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + } + ], + "documentation":"

Lists your streams.

The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Amazon Kinesis uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of 5 transactions per second per account.

" + }, + "ListTagsForStream":{ + "name":"ListTagsForStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListTagsForStreamInput", + "documentation":"

Represents the input for ListTagsForStream.

" + }, + "output":{ + "shape":"ListTagsForStreamOutput", + "documentation":"

Represents the output for ListTagsForStream.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + } + ], + "documentation":"

Lists the tags for the specified Amazon Kinesis stream.

" + }, + "MergeShards":{ + "name":"MergeShards", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"MergeShardsInput", + "documentation":"

Represents the input for MergeShards.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + } + ], + "documentation":"

Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.

MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see the Amazon Kinesis Developer Guide.

If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.

You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.

MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Amazon Kinesis sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you will receive a LimitExceededException.

MergeShards has limit of 5 transactions per second per account.

" + }, + "PutRecord":{ + "name":"PutRecord", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PutRecordInput", + "documentation":"

Represents the input for PutRecord.

" + }, + "output":{ + "shape":"PutRecordOutput", + "documentation":"

Represents the output for PutRecord.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + { + "shape":"ProvisionedThroughputExceededException", + "exception":true, + "documentation":"

The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.

" + } + ], + "documentation":"

Puts a data record from a producer into an Amazon Kinesis stream. You must call PutRecord to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing. You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself. The data blob could be a segment from a log file, geographic/location data, website clickstream data, or any other data type.

The partition key is used to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.

Partition keys are Unicode strings, with a maximum length limit of 256 bytes. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see the Amazon Kinesis Developer Guide.

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers generally increase over time. To guarantee strictly increasing ordering, use the SequenceNumberForOrdering parameter. For more information, see the Amazon Kinesis Developer Guide.

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.

Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.

" + }, + "RemoveTagsFromStream":{ + "name":"RemoveTagsFromStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTagsFromStreamInput", + "documentation":"

Represents the input for RemoveTagsFromStream.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + } + ], + "documentation":"

Deletes tags from the specified Amazon Kinesis stream.

If you specify a tag that does not exist, it is ignored.

" + }, + "SplitShard":{ + "name":"SplitShard", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SplitShardInput", + "documentation":"

Represents the input for SplitShard.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + { + "shape":"ResourceInUseException", + "exception":true, + "documentation":"

The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.

" + }, + { + "shape":"InvalidArgumentException", + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + } + ], + "documentation":"

Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested.

You can also use SplitShard when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.

You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see the Amazon Kinesis Developer Guide.

You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Amazon Kinesis immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Amazon Kinesis sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.

If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.

The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you receive a LimitExceededException.

SplitShard has limit of 5 transactions per second per account.

" + } + }, + "shapes":{ + "AddTagsToStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "Tags" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The set of key-value pairs to use to create the tags.

" + } + }, + "documentation":"

Represents the input for AddTagsToStream.

" + }, + "BooleanObject":{"type":"boolean"}, + "CreateStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardCount" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name, and two streams in the same AWS account, but in two different regions, can have the same name.

" + }, + "ShardCount":{ + "shape":"PositiveIntegerObject", + "documentation":"

The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

Note: The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.

" + } + }, + "documentation":"

Represents the input for CreateStream.

" + }, + "Data":{ + "type":"blob", + "min":0, + "max":51200 + }, + "DeleteStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to delete.

" + } + }, + "documentation":"

Represents the input for DeleteStream.

" + }, + "DescribeStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to describe.

" + }, + "Limit":{ + "shape":"DescribeStreamInputLimit", + "documentation":"

The maximum number of shards to return.

" + }, + "ExclusiveStartShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard to start with.

" + } + }, + "documentation":"

Represents the input for DescribeStream.

" + }, + "DescribeStreamInputLimit":{ + "type":"integer", + "min":1, + "max":10000 + }, + "DescribeStreamOutput":{ + "type":"structure", + "required":["StreamDescription"], + "members":{ + "StreamDescription":{ + "shape":"StreamDescription", + "documentation":"

The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and states whether there are more shards available.

" + } + }, + "documentation":"

Represents the output for DescribeStream.

" + }, + "ErrorMessage":{"type":"string"}, + "ExpiredIteratorException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "exception":true, + "documentation":"

The provided iterator exceeds the maximum age allowed.

" + }, + "GetRecordsInput":{ + "type":"structure", + "required":["ShardIterator"], + "members":{ + "ShardIterator":{ + "shape":"ShardIterator", + "documentation":"

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

" + }, + "Limit":{ + "shape":"GetRecordsInputLimit", + "documentation":"

The maximum size of data to return, in MB. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

" + } + }, + "documentation":"

Represents the input for GetRecords.

" + }, + "GetRecordsInputLimit":{ + "type":"integer", + "min":1, + "max":10000 + }, + "GetRecordsOutput":{ + "type":"structure", + "required":["Records"], + "members":{ + "Records":{ + "shape":"RecordList", + "documentation":"

The data records retrieved from the shard.

" + }, + "NextShardIterator":{ + "shape":"ShardIterator", + "documentation":"

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

" + } + }, + "documentation":"

Represents the output for GetRecords.

" + }, + "GetShardIteratorInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardId", + "ShardIteratorType" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "ShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard to get the iterator for.

" + }, + "ShardIteratorType":{ + "shape":"ShardIteratorType", + "documentation":"

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid shard iterator types:

" + }, + "StartingSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The sequence number of the data record in the shard from which to start reading from.

" + } + }, + "documentation":"

Represents the input for GetShardIterator.

" + }, + "GetShardIteratorOutput":{ + "type":"structure", + "members":{ + "ShardIterator":{ + "shape":"ShardIterator", + "documentation":"

The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.

" + } + }, + "documentation":"

Represents the output for GetShardIterator.

" + }, + "HashKey":{ + "type":"string", + "pattern":"0|([1-9]\\d{0,38})" + }, + "HashKeyRange":{ + "type":"structure", + "required":[ + "StartingHashKey", + "EndingHashKey" + ], + "members":{ + "StartingHashKey":{ + "shape":"HashKey", + "documentation":"

The starting hash key of the hash key range.

" + }, + "EndingHashKey":{ + "shape":"HashKey", + "documentation":"

The ending hash key of the hash key range.

" + } + }, + "documentation":"

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

" + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "exception":true, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "exception":true, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

" + }, + "ListStreamsInput":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"ListStreamsInputLimit", + "documentation":"

The maximum number of streams to list.

" + }, + "ExclusiveStartStreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to start the list with.

" + } + }, + "documentation":"

Represents the input for ListStreams.

" + }, + "ListStreamsInputLimit":{ + "type":"integer", + "min":1, + "max":10000 + }, + "ListStreamsOutput":{ + "type":"structure", + "required":[ + "StreamNames", + "HasMoreStreams" + ], + "members":{ + "StreamNames":{ + "shape":"StreamNameList", + "documentation":"

The names of the streams that are associated with the AWS account making the ListStreams request.

" + }, + "HasMoreStreams":{ + "shape":"BooleanObject", + "documentation":"

If set to true, there are more streams available to list.

" + } + }, + "documentation":"

Represents the output for ListStreams.

" + }, + "ListTagsForStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "ExclusiveStartTagKey":{ + "shape":"TagKey", + "documentation":"

The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

" + }, + "Limit":{ + "shape":"ListTagsForStreamInputLimit", + "documentation":"

The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

" + } + }, + "documentation":"

Represents the input for ListTagsForStream.

" + }, + "ListTagsForStreamInputLimit":{ + "type":"integer", + "min":1, + "max":10 + }, + "ListTagsForStreamOutput":{ + "type":"structure", + "required":[ + "Tags", + "HasMoreTags" + ], + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

" + }, + "HasMoreTags":{ + "shape":"BooleanObject", + "documentation":"

If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

" + } + }, + "documentation":"

Represents the output for ListTagsForStream.

" + }, + "MergeShardsInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardToMerge", + "AdjacentShardToMerge" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream for the merge.

" + }, + "ShardToMerge":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard to combine with the adjacent shard for the merge.

" + }, + "AdjacentShardToMerge":{ + "shape":"ShardId", + "documentation":"

The shard ID of the adjacent shard for the merge.

" + } + }, + "documentation":"

Represents the input for MergeShards.

" + }, + "PartitionKey":{ + "type":"string", + "min":1, + "max":256 + }, + "PositiveIntegerObject":{ + "type":"integer", + "min":1 + }, + "ProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "exception":true, + "documentation":"

The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.

" + }, + "PutRecordInput":{ + "type":"structure", + "required":[ + "StreamName", + "Data", + "PartitionKey" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to put the data record into.

" + }, + "Data":{ + "shape":"Data", + "documentation":"

The data blob to put into the record, which is Base64-encoded when the blob is serialized. The maximum size of the data blob (the payload after Base64-decoding) is 50 kilobytes (KB)

" + }, + "PartitionKey":{ + "shape":"PartitionKey", + "documentation":"

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 bytes. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key will map to the same shard within the stream.

" + }, + "ExplicitHashKey":{ + "shape":"HashKey", + "documentation":"

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

" + }, + "SequenceNumberForOrdering":{ + "shape":"SequenceNumber", + "documentation":"

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the PutRecordResult when putting record n-1). If this parameter is not set, records will be coarsely ordered based on arrival time.

" + } + }, + "documentation":"

Represents the input for PutRecord.

" + }, + "PutRecordOutput":{ + "type":"structure", + "required":[ + "ShardId", + "SequenceNumber" + ], + "members":{ + "ShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard where the data record was placed.

" + }, + "SequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

" + } + }, + "documentation":"

Represents the output for PutRecord.

" + }, + "Record":{ + "type":"structure", + "required":[ + "SequenceNumber", + "Data", + "PartitionKey" + ], + "members":{ + "SequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The unique identifier for the record in the Amazon Kinesis stream.

" + }, + "Data":{ + "shape":"Data", + "documentation":"

The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. The maximum size of the data blob (the payload after Base64-decoding) is 50 kilobytes (KB)

" + }, + "PartitionKey":{ + "shape":"PartitionKey", + "documentation":"

Identifies which shard in the stream the data record is assigned to.

" + } + }, + "documentation":"

The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.

" + }, + "RecordList":{ + "type":"list", + "member":{"shape":"Record"} + }, + "RemoveTagsFromStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "TagKeys" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of tag keys. Each corresponding tag is deleted from the stream.

" + } + }, + "documentation":"

Represents the input for RemoveTagsFromStream.

" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "exception":true, + "documentation":"

The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "exception":true, + "documentation":"

The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.

" + }, + "SequenceNumber":{ + "type":"string", + "pattern":"0|([1-9]\\d{0,128})" + }, + "SequenceNumberRange":{ + "type":"structure", + "required":["StartingSequenceNumber"], + "members":{ + "StartingSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The starting sequence number for the range.

" + }, + "EndingSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

" + } + }, + "documentation":"

The range of possible sequence numbers for the shard.

" + }, + "Shard":{ + "type":"structure", + "required":[ + "ShardId", + "HashKeyRange", + "SequenceNumberRange" + ], + "members":{ + "ShardId":{ + "shape":"ShardId", + "documentation":"

The unique identifier of the shard within the Amazon Kinesis stream.

" + }, + "ParentShardId":{ + "shape":"ShardId", + "documentation":"

The shard Id of the shard's parent.

" + }, + "AdjacentParentShardId":{ + "shape":"ShardId", + "documentation":"

The shard Id of the shard adjacent to the shard's parent.

" + }, + "HashKeyRange":{ + "shape":"HashKeyRange", + "documentation":"

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

" + }, + "SequenceNumberRange":{ + "shape":"SequenceNumberRange", + "documentation":"

The range of possible sequence numbers for the shard.

" + } + }, + "documentation":"

A uniquely identified group of data records in an Amazon Kinesis stream.

" + }, + "ShardId":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "ShardIterator":{ + "type":"string", + "min":1, + "max":512 + }, + "ShardIteratorType":{ + "type":"string", + "enum":[ + "AT_SEQUENCE_NUMBER", + "AFTER_SEQUENCE_NUMBER", + "TRIM_HORIZON", + "LATEST" + ] + }, + "ShardList":{ + "type":"list", + "member":{"shape":"Shard"} + }, + "SplitShardInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardToSplit", + "NewStartingHashKey" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream for the shard split.

" + }, + "ShardToSplit":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard to split.

" + }, + "NewStartingHashKey":{ + "shape":"HashKey", + "documentation":"

A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.

" + } + }, + "documentation":"

Represents the input for SplitShard.

" + }, + "StreamARN":{"type":"string"}, + "StreamDescription":{ + "type":"structure", + "required":[ + "StreamName", + "StreamARN", + "StreamStatus", + "Shards", + "HasMoreShards" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream being described.

" + }, + "StreamARN":{ + "shape":"StreamARN", + "documentation":"

The Amazon Resource Name (ARN) for the stream being described.

" + }, + "StreamStatus":{ + "shape":"StreamStatus", + "documentation":"

The current status of the stream being described.

The stream status is one of the following states:

" + }, + "Shards":{ + "shape":"ShardList", + "documentation":"

The shards that comprise the stream.

" + }, + "HasMoreShards":{ + "shape":"BooleanObject", + "documentation":"

If set to true, more shards in the stream are available to describe.

" + } + }, + "documentation":"

Represents the output for DescribeStream.

" + }, + "StreamName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "StreamNameList":{ + "type":"list", + "member":{"shape":"StreamName"} + }, + "StreamStatus":{ + "type":"string", + "enum":[ + "CREATING", + "DELETING", + "ACTIVE", + "UPDATING" + ] + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" + } + }, + "documentation":"

Metadata assigned to the stream, consisting of a key-value pair.

" + }, + "TagKey":{ + "type":"string", + "min":1, + "max":128 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "min":1, + "max":10 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "min":1, + "max":10 + }, + "TagValue":{ + "type":"string", + "min":0, + "max":256 + } + } +} diff --git a/apis/kinesis-2013-12-02.paginators.json b/apis/kinesis-2013-12-02.paginators.json new file mode 100644 index 0000000000..007f563b4a --- /dev/null +++ b/apis/kinesis-2013-12-02.paginators.json @@ -0,0 +1,18 @@ +{ + "pagination": { + "DescribeStream": { + "input_token": "ExclusiveStartShardId", + "limit_key": "Limit", + "more_results": "StreamDescription.HasMoreShards", + "output_token": "StreamDescription.Shards[-1].ShardId", + "result_key": "StreamDescription.Shards" + }, + "ListStreams": { + "input_token": "ExclusiveStartStreamName", + "limit_key": "Limit", + "more_results": "HasMoreStreams", + "output_token": "StreamNames[-1]", + "result_key": "StreamNames" + } + } +} diff --git a/apis/logs-2014-03-28.api.json b/apis/logs-2014-03-28.api.json new file mode 100644 index 0000000000..c61bcddf31 --- /dev/null +++ b/apis/logs-2014-03-28.api.json @@ -0,0 +1,386 @@ +{ + "metadata": { + "apiVersion": "2014-03-28", + "endpointPrefix": "logs", + "jsonVersion": "1.1", + "serviceFullName": "Amazon CloudWatch Logs", + "signatureVersion": "v4", + "targetPrefix": "Logs_20140328", + "protocol": "json" + }, + "operations": { + "CreateLogGroup": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {} + } + } + }, + "CreateLogStream": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "logStreamName" + ], + "members": { + "logGroupName": {}, + "logStreamName": {} + } + } + }, + "DeleteLogGroup": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {} + } + } + }, + "DeleteLogStream": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "logStreamName" + ], + "members": { + "logGroupName": {}, + "logStreamName": {} + } + } + }, + "DeleteMetricFilter": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "filterName" + ], + "members": { + "logGroupName": {}, + "filterName": {} + } + } + }, + "DeleteRetentionPolicy": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {} + } + } + }, + "DescribeLogGroups": { + "input": { + "type": "structure", + "members": { + "logGroupNamePrefix": {}, + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "logGroups": { + "type": "list", + "member": { + "type": "structure", + "members": { + "logGroupName": {}, + "creationTime": { + "type": "long" + }, + "retentionInDays": { + "type": "integer" + }, + "metricFilterCount": { + "type": "integer" + }, + "arn": {}, + "storedBytes": { + "type": "long" + } + } + } + }, + "nextToken": {} + } + } + }, + "DescribeLogStreams": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {}, + "logStreamNamePrefix": {}, + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "logStreams": { + "type": "list", + "member": { + "type": "structure", + "members": { + "logStreamName": {}, + "creationTime": { + "type": "long" + }, + "firstEventTimestamp": { + "type": "long" + }, + "lastEventTimestamp": { + "type": "long" + }, + "lastIngestionTime": { + "type": "long" + }, + "uploadSequenceToken": {}, + "arn": {}, + "storedBytes": { + "type": "long" + } + } + } + }, + "nextToken": {} + } + } + }, + "DescribeMetricFilters": { + "input": { + "type": "structure", + "required": [ + "logGroupName" + ], + "members": { + "logGroupName": {}, + "filterNamePrefix": {}, + "nextToken": {}, + "limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "metricFilters": { + "type": "list", + "member": { + "type": "structure", + "members": { + "filterName": {}, + "filterPattern": {}, + "metricTransformations": { + "shape": "Sv" + }, + "creationTime": { + "type": "long" + } + } + } + }, + "nextToken": {} + } + } + }, + "GetLogEvents": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "logStreamName" + ], + "members": { + "logGroupName": {}, + "logStreamName": {}, + "startTime": { + "type": "long" + }, + "endTime": { + "type": "long" + }, + "nextToken": {}, + "limit": { + "type": "integer" + }, + "startFromHead": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "events": { + "type": "list", + "member": { + "type": "structure", + "members": { + "timestamp": { + "type": "long" + }, + "message": {}, + "ingestionTime": { + "type": "long" + } + } + } + }, + "nextForwardToken": {}, + "nextBackwardToken": {} + } + } + }, + "PutLogEvents": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "logStreamName", + "logEvents" + ], + "members": { + "logGroupName": {}, + "logStreamName": {}, + "logEvents": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "timestamp", + "message" + ], + "members": { + "timestamp": { + "type": "long" + }, + "message": {} + } + } + }, + "sequenceToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "nextSequenceToken": {} + } + } + }, + "PutMetricFilter": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "filterName", + "filterPattern", + "metricTransformations" + ], + "members": { + "logGroupName": {}, + "filterName": {}, + "filterPattern": {}, + "metricTransformations": { + "shape": "Sv" + } + } + } + }, + "PutRetentionPolicy": { + "input": { + "type": "structure", + "required": [ + "logGroupName", + "retentionInDays" + ], + "members": { + "logGroupName": {}, + "retentionInDays": { + "type": "integer" + } + } + } + }, + "TestMetricFilter": { + "input": { + "type": "structure", + "required": [ + "filterPattern", + "logEventMessages" + ], + "members": { + "filterPattern": {}, + "logEventMessages": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "matches": { + "type": "list", + "member": { + "type": "structure", + "members": { + "eventNumber": { + "type": "long" + }, + "eventMessage": {}, + "extractedValues": { + "type": "map", + "key": {}, + "value": {} + } + } + } + } + } + } + } + }, + "shapes": { + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "metricName", + "metricNamespace", + "metricValue" + ], + "members": { + "metricName": {}, + "metricNamespace": {}, + "metricValue": {} + } + } + } + } +} \ No newline at end of file diff --git a/apis/logs-2014-03-28.full.json b/apis/logs-2014-03-28.full.json new file mode 100644 index 0000000000..8eb02045ab --- /dev/null +++ b/apis/logs-2014-03-28.full.json @@ -0,0 +1,935 @@ +{ + "metadata":{ + "apiVersion":"2014-03-28", + "endpointPrefix":"logs", + "jsonVersion":"1.1", + "serviceFullName":"Amazon CloudWatch Logs", + "signatureVersion":"v4", + "targetPrefix":"Logs_20140328", + "protocol":"json" + }, + "documentation":"Amazon CloudWatch Logs Service API Reference

This is the Amazon CloudWatch Logs API Reference. Amazon CloudWatch Logs is a managed service for real time monitoring and archival of application logs. This guide provides detailed information about Amazon CloudWatch Logs actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls, go to the Amazon CloudWatch Logs Developer Guide.

Use the following links to get started using the Amazon CloudWatch Logs API Reference:

In addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch Logs programmatically.

Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:

", + "operations":{ + "CreateLogGroup":{ + "name":"CreateLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLogGroupRequest"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceAlreadyExistsException", + "exception":true, + "documentation":"

Returned if the specified resource already exists.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

Returned if you have reached the maximum number of resources that can be created.

" + }, + { + "shape":"OperationAbortedException", + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.

You must use the following guidelines when naming a log group:

" + }, + "CreateLogStream":{ + "name":"CreateLogStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLogStreamRequest"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceAlreadyExistsException", + "exception":true, + "documentation":"

Returned if the specified resource already exists.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.

You must use the following guidelines when naming a log stream:

" + }, + "DeleteLogGroup":{ + "name":"DeleteLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLogGroupRequest"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"OperationAbortedException", + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.

" + }, + "DeleteLogStream":{ + "name":"DeleteLogStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLogStreamRequest"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"OperationAbortedException", + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Deletes a log stream and permanently deletes all the archived log events associated with it.

" + }, + "DeleteMetricFilter":{ + "name":"DeleteMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMetricFilterRequest"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"OperationAbortedException", + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Deletes a metric filter associated with the specified log group.

" + }, + "DeleteRetentionPolicy":{ + "name":"DeleteRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRetentionPolicyRequest"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"OperationAbortedException", + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.

" + }, + "DescribeLogGroups":{ + "name":"DescribeLogGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLogGroupsRequest"}, + "output":{"shape":"DescribeLogGroupsResponse"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

" + }, + "DescribeLogStreams":{ + "name":"DescribeLogStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLogStreamsRequest"}, + "output":{"shape":"DescribeLogStreamsResponse"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request.

" + }, + "DescribeMetricFilters":{ + "name":"DescribeMetricFilters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMetricFiltersRequest"}, + "output":{"shape":"DescribeMetricFiltersResponse"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

" + }, + "GetLogEvents":{ + "name":"GetLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLogEventsRequest"}, + "output":{"shape":"GetLogEventsResponse"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp.

By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

" + }, + "PutLogEvents":{ + "name":"PutLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLogEventsRequest"}, + "output":{"shape":"PutLogEventsResponse"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"InvalidSequenceTokenException", + "exception":true + }, + { + "shape":"DataAlreadyAcceptedException", + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"OperationAbortedException", + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Uploads a batch of log events to the specified log stream.

Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken.

The batch of events must satisfy the following constraints:

" + }, + "PutMetricFilter":{ + "name":"PutMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricFilterRequest"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"OperationAbortedException", + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

Returned if you have reached the maximum number of resources that can be created.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.

" + }, + "PutRetentionPolicy":{ + "name":"PutRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRetentionPolicyRequest"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + { + "shape":"OperationAbortedException", + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.

" + }, + "TestMetricFilter":{ + "name":"TestMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestMetricFilterRequest"}, + "output":{"shape":"TestMetricFilterResponse"}, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + { + "shape":"ServiceUnavailableException", + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + } + ], + "documentation":"

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

" + } + }, + "shapes":{ + "Arn":{"type":"string"}, + "CreateLogGroupRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"} + } + }, + "CreateLogStreamRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamName":{"shape":"LogStreamName"} + } + }, + "DataAlreadyAcceptedException":{ + "type":"structure", + "members":{ + "expectedSequenceToken":{"shape":"SequenceToken"} + }, + "exception":true + }, + "Days":{ + "type":"integer", + "documentation":"Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 547, 730." + }, + "DeleteLogGroupRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"} + } + }, + "DeleteLogStreamRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamName":{"shape":"LogStreamName"} + } + }, + "DeleteMetricFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterName":{"shape":"FilterName"} + } + }, + "DeleteRetentionPolicyRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"} + } + }, + "DescribeLimit":{ + "type":"integer", + "min":1, + "max":50, + "documentation":"The maximum number of results to return." + }, + "DescribeLogGroupsRequest":{ + "type":"structure", + "members":{ + "logGroupNamePrefix":{"shape":"LogGroupName"}, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogGroups request.

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

" + } + } + }, + "DescribeLogGroupsResponse":{ + "type":"structure", + "members":{ + "logGroups":{"shape":"LogGroups"}, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeLogStreamsRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamNamePrefix":{"shape":"LogStreamName"}, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

" + } + } + }, + "DescribeLogStreamsResponse":{ + "type":"structure", + "members":{ + "logStreams":{"shape":"LogStreams"}, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeMetricFiltersRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterNamePrefix":{"shape":"FilterName"}, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

" + } + } + }, + "DescribeMetricFiltersResponse":{ + "type":"structure", + "members":{ + "metricFilters":{"shape":"MetricFilters"}, + "nextToken":{"shape":"NextToken"} + } + }, + "EventMessage":{ + "type":"string", + "min":1, + "max":32768 + }, + "EventNumber":{"type":"long"}, + "EventsLimit":{ + "type":"integer", + "min":1, + "max":10000, + "documentation":"The maximum number of events to return." + }, + "ExtractedValues":{ + "type":"map", + "key":{"shape":"Token"}, + "value":{"shape":"Value"} + }, + "FilterCount":{ + "type":"integer", + "documentation":"The number of metric filters associated with the log group." + }, + "FilterName":{ + "type":"string", + "min":1, + "max":512, + "pattern":"[^:*]*", + "documentation":"The name of the metric filter." + }, + "FilterPattern":{ + "type":"string", + "min":0, + "max":512 + }, + "GetLogEventsRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamName":{"shape":"LogStreamName"}, + "startTime":{"shape":"Timestamp"}, + "endTime":{"shape":"Timestamp"}, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

" + }, + "limit":{ + "shape":"EventsLimit", + "documentation":"

The maximum number of log events returned in the response. If you don't specify a value, the request would return as much log events as can fit in a response size of 1MB, up to 10,000 log events.

" + }, + "startFromHead":{"shape":"StartFromHead"} + } + }, + "GetLogEventsResponse":{ + "type":"structure", + "members":{ + "events":{"shape":"OutputLogEvents"}, + "nextForwardToken":{"shape":"NextToken"}, + "nextBackwardToken":{"shape":"NextToken"} + } + }, + "InputLogEvent":{ + "type":"structure", + "required":[ + "timestamp", + "message" + ], + "members":{ + "timestamp":{"shape":"Timestamp"}, + "message":{"shape":"EventMessage"} + }, + "documentation":"A log event is a record of some activity that was recorded by the application or resource being monitored. The log event record that Amazon CloudWatch Logs understands contains two properties: the timestamp of when the event occurred, and the raw event message." + }, + "InputLogEvents":{ + "type":"list", + "member":{"shape":"InputLogEvent"}, + "min":1, + "max":1000, + "documentation":"A list of events belonging to a log stream." + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + }, + "InvalidSequenceTokenException":{ + "type":"structure", + "members":{ + "expectedSequenceToken":{"shape":"SequenceToken"} + }, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

Returned if you have reached the maximum number of resources that can be created.

" + }, + "LogGroup":{ + "type":"structure", + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "creationTime":{"shape":"Timestamp"}, + "retentionInDays":{"shape":"Days"}, + "metricFilterCount":{"shape":"FilterCount"}, + "arn":{"shape":"Arn"}, + "storedBytes":{"shape":"StoredBytes"} + } + }, + "LogGroupName":{ + "type":"string", + "min":1, + "max":512, + "pattern":"[\\.\\-_/#A-Za-z0-9]+" + }, + "LogGroups":{ + "type":"list", + "member":{"shape":"LogGroup"}, + "documentation":"A list of log groups." + }, + "LogStream":{ + "type":"structure", + "members":{ + "logStreamName":{"shape":"LogStreamName"}, + "creationTime":{"shape":"Timestamp"}, + "firstEventTimestamp":{"shape":"Timestamp"}, + "lastEventTimestamp":{"shape":"Timestamp"}, + "lastIngestionTime":{"shape":"Timestamp"}, + "uploadSequenceToken":{"shape":"SequenceToken"}, + "arn":{"shape":"Arn"}, + "storedBytes":{"shape":"StoredBytes"} + }, + "documentation":"A log stream is sequence of log events that share the same emitter." + }, + "LogStreamName":{ + "type":"string", + "min":1, + "max":512, + "pattern":"[^:*]*" + }, + "LogStreams":{ + "type":"list", + "member":{"shape":"LogStream"}, + "documentation":"A list of log streams." + }, + "MetricFilter":{ + "type":"structure", + "members":{ + "filterName":{"shape":"FilterName"}, + "filterPattern":{"shape":"FilterPattern"}, + "metricTransformations":{"shape":"MetricTransformations"}, + "creationTime":{"shape":"Timestamp"} + }, + "documentation":"Metric filters can be used to express how Amazon CloudWatch Logs would extract metric observations from ingested log events and transform them to metric data in a CloudWatch metric." + }, + "MetricFilterMatchRecord":{ + "type":"structure", + "members":{ + "eventNumber":{"shape":"EventNumber"}, + "eventMessage":{"shape":"EventMessage"}, + "extractedValues":{"shape":"ExtractedValues"} + } + }, + "MetricFilterMatches":{ + "type":"list", + "member":{"shape":"MetricFilterMatchRecord"} + }, + "MetricFilters":{ + "type":"list", + "member":{"shape":"MetricFilter"} + }, + "MetricName":{ + "type":"string", + "max":255, + "pattern":"[^:*$]*" + }, + "MetricNamespace":{ + "type":"string", + "max":255, + "pattern":"[^:*$]*" + }, + "MetricTransformation":{ + "type":"structure", + "required":[ + "metricName", + "metricNamespace", + "metricValue" + ], + "members":{ + "metricName":{"shape":"MetricName"}, + "metricNamespace":{"shape":"MetricNamespace"}, + "metricValue":{"shape":"MetricValue"} + } + }, + "MetricTransformations":{ + "type":"list", + "member":{"shape":"MetricTransformation"}, + "min":1, + "max":1 + }, + "MetricValue":{ + "type":"string", + "max":100 + }, + "NextToken":{ + "type":"string", + "documentation":"A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours." + }, + "OperationAbortedException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

Returned if multiple requests to update the same resource were in conflict.

" + }, + "OutputLogEvent":{ + "type":"structure", + "members":{ + "timestamp":{"shape":"Timestamp"}, + "message":{"shape":"EventMessage"}, + "ingestionTime":{"shape":"Timestamp"} + } + }, + "OutputLogEvents":{ + "type":"list", + "member":{"shape":"OutputLogEvent"} + }, + "PutLogEventsRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName", + "logEvents" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamName":{"shape":"LogStreamName"}, + "logEvents":{"shape":"InputLogEvents"}, + "sequenceToken":{ + "shape":"SequenceToken", + "documentation":"

A string token that must be obtained from the response of the previous PutLogEvents request.

" + } + } + }, + "PutLogEventsResponse":{ + "type":"structure", + "members":{ + "nextSequenceToken":{"shape":"SequenceToken"} + } + }, + "PutMetricFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName", + "filterPattern", + "metricTransformations" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterName":{"shape":"FilterName"}, + "filterPattern":{"shape":"FilterPattern"}, + "metricTransformations":{"shape":"MetricTransformations"} + } + }, + "PutRetentionPolicyRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "retentionInDays" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "retentionInDays":{"shape":"Days"} + } + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

Returned if the specified resource already exists.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

Returned if the specified resource does not exist.

" + }, + "SequenceToken":{ + "type":"string", + "min":1, + "documentation":"A string token used for making PutLogEvents requests. A sequenceToken can only be used once, and PutLogEvents requests must include the sequenceToken obtained from the response of the previous request." + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "fault":true, + "documentation":"

Returned if the service cannot complete the request.

" + }, + "StartFromHead":{"type":"boolean"}, + "StoredBytes":{ + "type":"long", + "min":0 + }, + "TestEventMessages":{ + "type":"list", + "member":{"shape":"EventMessage"}, + "min":1, + "max":50 + }, + "TestMetricFilterRequest":{ + "type":"structure", + "required":[ + "filterPattern", + "logEventMessages" + ], + "members":{ + "filterPattern":{"shape":"FilterPattern"}, + "logEventMessages":{"shape":"TestEventMessages"} + } + }, + "TestMetricFilterResponse":{ + "type":"structure", + "members":{ + "matches":{"shape":"MetricFilterMatches"} + } + }, + "Timestamp":{ + "type":"long", + "min":0, + "documentation":"A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC." + }, + "Token":{"type":"string"}, + "Value":{"type":"string"} + } +} diff --git a/apis/logs-2014-03-28.paginators.json b/apis/logs-2014-03-28.paginators.json new file mode 100644 index 0000000000..461b4a1512 --- /dev/null +++ b/apis/logs-2014-03-28.paginators.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "DescribeLogGroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "logGroups" + }, + "DescribeLogStreams": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "logStreams" + }, + "DescribeMetricFilters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "metricFilters" + }, + "GetLogEvents": { + "input_token": "nextToken", + "output_token": "nextForwardToken", + "limit_key": "limit", + "result_key": "events" + } + } +} diff --git a/apis/metadata.json b/apis/metadata.json new file mode 100644 index 0000000000..125613451b --- /dev/null +++ b/apis/metadata.json @@ -0,0 +1,124 @@ +{ + "autoscaling": { + "name": "AutoScaling" + }, + "cloudformation": { + "name": "CloudFormation" + }, + "cloudfront": { + "name": "CloudFront", + "versions": ["2013-05-12*", "2013-11-11*"] + }, + "cloudsearch": { + "name": "CloudSearch" + }, + "cloudsearchdomain": { + "name": "CloudSearchDomain" + }, + "cloudtrail": { + "name": "CloudTrail" + }, + "cloudwatch": { + "prefix": "monitoring", + "name": "CloudWatch" + }, + "cloudwatchlogs": { + "prefix": "logs", + "name": "CloudWatchLogs" + }, + "cognitoidentity": { + "prefix": "cognito-identity", + "name": "CognitoIdentity" + }, + "cognitosync": { + "prefix": "cognito-sync", + "name": "CognitoSync" + }, + "datapipeline": { + "name": "DataPipeline" + }, + "directconnect": { + "name": "DirectConnect" + }, + "dynamodb": { + "name": "DynamoDB" + }, + "ec2": { + "name": "EC2", + "versions": ["2013-06-15*", "2013-10-15*", "2014-02-01*", "2014-05-01*"] + }, + "elasticache": { + "name": "ElastiCache", + "versions": ["2012-11-15*", "2014-03-24*"] + }, + "elasticbeanstalk": { + "name": "ElasticBeanstalk" + }, + "elb": { + "prefix": "elasticloadbalancing", + "name": "ELB" + }, + "emr": { + "prefix": "elasticmapreduce", + "name": "EMR" + }, + "elastictranscoder": { + "name": "ElasticTranscoder" + }, + "glacier": { + "name": "Glacier" + }, + "iam": { + "name": "IAM" + }, + "importexport": { + "name": "ImportExport" + }, + "kinesis": { + "name": "Kinesis" + }, + "opsworks": { + "name": "OpsWorks" + }, + "rds": { + "name": "RDS" + }, + "redshift": { + "name": "Redshift" + }, + "route53": { + "name": "Route53" + }, + "route53domains": { + "name": "Route53Domains" + }, + "s3": { + "name": "S3" + }, + "ses": { + "prefix": "email", + "name": "SES" + }, + "simpledb": { + "prefix": "sdb", + "name": "SimpleDB" + }, + "sns": { + "name": "SNS" + }, + "sqs": { + "name": "SQS" + }, + "storagegateway": { + "name": "StorageGateway" + }, + "sts": { + "name": "STS" + }, + "support": { + "name": "Support" + }, + "swf": { + "name": "SWF" + } +} diff --git a/apis/monitoring-2010-08-01.api.json b/apis/monitoring-2010-08-01.api.json new file mode 100644 index 0000000000..8fe06d54d5 --- /dev/null +++ b/apis/monitoring-2010-08-01.api.json @@ -0,0 +1,500 @@ +{ + "metadata": { + "apiVersion": "2010-08-01", + "endpointPrefix": "monitoring", + "serviceAbbreviation": "CloudWatch", + "serviceFullName": "Amazon CloudWatch", + "signatureVersion": "v4", + "xmlNamespace": "http://monitoring.amazonaws.com/doc/2010-08-01/", + "protocol": "query" + }, + "operations": { + "DeleteAlarms": { + "input": { + "type": "structure", + "required": [ + "AlarmNames" + ], + "members": { + "AlarmNames": { + "shape": "S2" + } + } + } + }, + "DescribeAlarmHistory": { + "input": { + "type": "structure", + "members": { + "AlarmName": {}, + "HistoryItemType": {}, + "StartDate": { + "type": "timestamp" + }, + "EndDate": { + "type": "timestamp" + }, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeAlarmHistoryResult", + "type": "structure", + "members": { + "AlarmHistoryItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AlarmName": {}, + "Timestamp": { + "type": "timestamp" + }, + "HistoryItemType": {}, + "HistorySummary": {}, + "HistoryData": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeAlarms": { + "input": { + "type": "structure", + "members": { + "AlarmNames": { + "shape": "S2" + }, + "AlarmNamePrefix": {}, + "StateValue": {}, + "ActionPrefix": {}, + "MaxRecords": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "DescribeAlarmsResult", + "type": "structure", + "members": { + "MetricAlarms": { + "shape": "Sj" + }, + "NextToken": {} + } + } + }, + "DescribeAlarmsForMetric": { + "input": { + "type": "structure", + "required": [ + "MetricName", + "Namespace" + ], + "members": { + "MetricName": {}, + "Namespace": {}, + "Statistic": {}, + "Dimensions": { + "shape": "Sv" + }, + "Period": { + "type": "integer" + }, + "Unit": {} + } + }, + "output": { + "resultWrapper": "DescribeAlarmsForMetricResult", + "type": "structure", + "members": { + "MetricAlarms": { + "shape": "Sj" + } + } + } + }, + "DisableAlarmActions": { + "input": { + "type": "structure", + "required": [ + "AlarmNames" + ], + "members": { + "AlarmNames": { + "shape": "S2" + } + } + } + }, + "EnableAlarmActions": { + "input": { + "type": "structure", + "required": [ + "AlarmNames" + ], + "members": { + "AlarmNames": { + "shape": "S2" + } + } + } + }, + "GetMetricStatistics": { + "input": { + "type": "structure", + "required": [ + "Namespace", + "MetricName", + "StartTime", + "EndTime", + "Period", + "Statistics" + ], + "members": { + "Namespace": {}, + "MetricName": {}, + "Dimensions": { + "shape": "Sv" + }, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Period": { + "type": "integer" + }, + "Statistics": { + "type": "list", + "member": {} + }, + "Unit": {} + } + }, + "output": { + "resultWrapper": "GetMetricStatisticsResult", + "type": "structure", + "members": { + "Label": {}, + "Datapoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Timestamp": { + "type": "timestamp" + }, + "SampleCount": { + "type": "double" + }, + "Average": { + "type": "double" + }, + "Sum": { + "type": "double" + }, + "Minimum": { + "type": "double" + }, + "Maximum": { + "type": "double" + }, + "Unit": {} + }, + "xmlOrder": [ + "Timestamp", + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum", + "Unit" + ] + } + } + } + } + }, + "ListMetrics": { + "input": { + "type": "structure", + "members": { + "Namespace": {}, + "MetricName": {}, + "Dimensions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Value": {} + } + } + }, + "NextToken": {} + } + }, + "output": { + "xmlOrder": [ + "Metrics", + "NextToken" + ], + "resultWrapper": "ListMetricsResult", + "type": "structure", + "members": { + "Metrics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Namespace": {}, + "MetricName": {}, + "Dimensions": { + "shape": "Sv" + } + }, + "xmlOrder": [ + "Namespace", + "MetricName", + "Dimensions" + ] + } + }, + "NextToken": {} + } + } + }, + "PutMetricAlarm": { + "input": { + "type": "structure", + "required": [ + "AlarmName", + "MetricName", + "Namespace", + "Statistic", + "Period", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator" + ], + "members": { + "AlarmName": {}, + "AlarmDescription": {}, + "ActionsEnabled": { + "type": "boolean" + }, + "OKActions": { + "shape": "So" + }, + "AlarmActions": { + "shape": "So" + }, + "InsufficientDataActions": { + "shape": "So" + }, + "MetricName": {}, + "Namespace": {}, + "Statistic": {}, + "Dimensions": { + "shape": "Sv" + }, + "Period": { + "type": "integer" + }, + "Unit": {}, + "EvaluationPeriods": { + "type": "integer" + }, + "Threshold": { + "type": "double" + }, + "ComparisonOperator": {} + } + } + }, + "PutMetricData": { + "input": { + "type": "structure", + "required": [ + "Namespace", + "MetricData" + ], + "members": { + "Namespace": {}, + "MetricData": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "MetricName" + ], + "members": { + "MetricName": {}, + "Dimensions": { + "shape": "Sv" + }, + "Timestamp": { + "type": "timestamp" + }, + "Value": { + "type": "double" + }, + "StatisticValues": { + "type": "structure", + "required": [ + "SampleCount", + "Sum", + "Minimum", + "Maximum" + ], + "members": { + "SampleCount": { + "type": "double" + }, + "Sum": { + "type": "double" + }, + "Minimum": { + "type": "double" + }, + "Maximum": { + "type": "double" + } + } + }, + "Unit": {} + } + } + } + } + } + }, + "SetAlarmState": { + "input": { + "type": "structure", + "required": [ + "AlarmName", + "StateValue", + "StateReason" + ], + "members": { + "AlarmName": {}, + "StateValue": {}, + "StateReason": {}, + "StateReasonData": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "Sj": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AlarmName": {}, + "AlarmArn": {}, + "AlarmDescription": {}, + "AlarmConfigurationUpdatedTimestamp": { + "type": "timestamp" + }, + "ActionsEnabled": { + "type": "boolean" + }, + "OKActions": { + "shape": "So" + }, + "AlarmActions": { + "shape": "So" + }, + "InsufficientDataActions": { + "shape": "So" + }, + "StateValue": {}, + "StateReason": {}, + "StateReasonData": {}, + "StateUpdatedTimestamp": { + "type": "timestamp" + }, + "MetricName": {}, + "Namespace": {}, + "Statistic": {}, + "Dimensions": { + "shape": "Sv" + }, + "Period": { + "type": "integer" + }, + "Unit": {}, + "EvaluationPeriods": { + "type": "integer" + }, + "Threshold": { + "type": "double" + }, + "ComparisonOperator": {} + }, + "xmlOrder": [ + "AlarmName", + "AlarmArn", + "AlarmDescription", + "AlarmConfigurationUpdatedTimestamp", + "ActionsEnabled", + "OKActions", + "AlarmActions", + "InsufficientDataActions", + "StateValue", + "StateReason", + "StateReasonData", + "StateUpdatedTimestamp", + "MetricName", + "Namespace", + "Statistic", + "Dimensions", + "Period", + "Unit", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator" + ] + } + }, + "So": { + "type": "list", + "member": {} + }, + "Sv": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + }, + "xmlOrder": [ + "Name", + "Value" + ] + } + } + } +} \ No newline at end of file diff --git a/apis/monitoring-2010-08-01.full.json b/apis/monitoring-2010-08-01.full.json new file mode 100644 index 0000000000..9b05411cbd --- /dev/null +++ b/apis/monitoring-2010-08-01.full.json @@ -0,0 +1,1338 @@ +{ + "metadata":{ + "apiVersion":"2010-08-01", + "endpointPrefix":"monitoring", + "serviceAbbreviation":"CloudWatch", + "serviceFullName":"Amazon CloudWatch", + "signatureVersion":"v4", + "xmlNamespace":"http://monitoring.amazonaws.com/doc/2010-08-01/", + "protocol":"query" + }, + "documentation":"

This is the Amazon CloudWatch API Reference. This guide provides detailed\n\t\t\tinformation about Amazon CloudWatch actions, data types, parameters, and\n\t\t\terrors. For detailed information about Amazon CloudWatch features and their associated API calls,\n\t\t\tgo to the Amazon CloudWatch Developer Guide.\n\t\t

\n\t\t

Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics,\n\t\t\tas well as configure alarm actions based on data from metrics. For more information about this product\n\t\t\tgo to http://aws.amazon.com/cloudwatch.\n\t\t

\n\n

\n\t\t\tFor information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch,\n\t\t\tgo to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference\n\t\t\tin the Amazon CloudWatch Developer Guide.\n\t\t

\n\n\t\t

Use the following links to get started using the Amazon CloudWatch API Reference:

\n\t\t\n\t\t\n\t\t\n\t\t

In addition to using the Amazon CloudWatch API, you can also use the following SDKs and third-party libraries to\n\t\t\taccess Amazon CloudWatch programmatically.

\n\t\t\n\t\t\n\t\t\n\t\t

Developers in the AWS developer community also provide their\town libraries, which you can find at the following AWS developer\n\t\t\tcenters:

\n\t\t", + "operations":{ + "DeleteAlarms":{ + "name":"DeleteAlarms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAlarmsInput"}, + "errors":[ + { + "shape":"ResourceNotFound", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tThe named resource does not exist.\n\t\t

" + } + ], + "documentation":"

\n\t\tDeletes all specified alarms.\n\t\tIn the event of an error, no alarms are deleted.\n\t\t

" + }, + "DescribeAlarmHistory":{ + "name":"DescribeAlarmHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmHistoryInput"}, + "output":{ + "shape":"DescribeAlarmHistoryOutput", + "documentation":"

\n\t\tThe output for the DescribeAlarmHistory action.\n\t\t

", + "resultWrapper":"DescribeAlarmHistoryResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tThe next token specified is invalid.\n\t\t

" + } + ], + "documentation":"

\n\t\tRetrieves history for the specified alarm.\n\t\tFilter alarms by date range or item type.\n\t\tIf an alarm name is not specified,\n\t\tAmazon CloudWatch returns histories for\n\t\tall of the owner's alarms.\n\t\t

\n\t\t\n\t\tAmazon CloudWatch retains the history of an alarm\n\t\tfor two weeks, whether or not you delete the alarm.\n\t\t" + }, + "DescribeAlarms":{ + "name":"DescribeAlarms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmsInput"}, + "output":{ + "shape":"DescribeAlarmsOutput", + "documentation":"

\n\t\tThe output for the DescribeAlarms action.\n\t\t

", + "resultWrapper":"DescribeAlarmsResult" + }, + "errors":[ + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tThe next token specified is invalid.\n\t\t

" + } + ], + "documentation":"

\n\t\tRetrieves alarms with the specified names.\n\t\tIf no name is specified, all alarms for the user are returned.\n\t\tAlarms can be retrieved by using only a prefix for the alarm name,\n\t\tthe alarm state, or a prefix for any action.\n\t\t

" + }, + "DescribeAlarmsForMetric":{ + "name":"DescribeAlarmsForMetric", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmsForMetricInput"}, + "output":{ + "shape":"DescribeAlarmsForMetricOutput", + "documentation":"

\n\t\tThe output for the DescribeAlarmsForMetric action.\n\t\t

", + "resultWrapper":"DescribeAlarmsForMetricResult" + }, + "documentation":"

\n\t\tRetrieves all alarms for a single metric.\n\t\tSpecify a statistic, period, or unit to filter\n\t\tthe set of alarms further.\n\t\t

" + }, + "DisableAlarmActions":{ + "name":"DisableAlarmActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DisableAlarmActionsInput", + "documentation":"

\n\n\t\t

" + }, + "documentation":"

\n\t\tDisables actions for the specified alarms.\n\t\tWhen an alarm's actions are disabled the\n\t\talarm's state may change, but none of the\n\t\talarm's actions will execute.\n\t\t

" + }, + "EnableAlarmActions":{ + "name":"EnableAlarmActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableAlarmActionsInput"}, + "documentation":"

\n\t\tEnables actions for the specified alarms.\n\t\t

" + }, + "GetMetricStatistics":{ + "name":"GetMetricStatistics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMetricStatisticsInput"}, + "output":{ + "shape":"GetMetricStatisticsOutput", + "documentation":"

\n\t\tThe output for the GetMetricStatistics action.\n\t\t

", + "resultWrapper":"GetMetricStatisticsResult" + }, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tBad or out-of-range value was supplied for the input\n\t\tparameter.\n\t\t

" + }, + { + "shape":"MissingRequiredParameterException", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tAn input parameter that is mandatory for processing\n\t\tthe request is not supplied.\n\t\t

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tParameters that must not be used together were\n\t\tused together.\n\t\t

" + }, + { + "shape":"InternalServiceFault", + "error":{ + "code":"InternalServiceError", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

\n\t\tIndicates that the request processing has\n\t\tfailed due to some unknown error, exception, or failure.\n\t\t

", + "xmlOrder":["Message"] + } + ], + "documentation":"

\n\t\tGets statistics for the specified metric.\n\t

\n\t\t

\n\t\t\tThe maximum number of data points returned from a single\n\t\t\tGetMetricStatistics request is 1,440, wereas the maximum number of data points\n\t\t\tthat can be queried is 50,850. If you make a request that generates more than 1,440 data points,\n\t\t\tAmazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified\n\t\t\ttime range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges.\n\t\t

\n\t\t

\n\t\t\tAmazon CloudWatch aggregates data points based on the\n\t\t\tlength of the period that you specify. For example, if\n\t\t\tyou request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points\n\t\t\twith time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned.\n\t\t

\n\n\t\t

\n\t\tThe following examples show various statistics allowed by the data point query maximum of 50,850\n\t\twhen you call GetMetricStatistics on Amazon EC2 instances with\n\t\tdetailed (one-minute) monitoring enabled:\n\t\t

\n\t\t\n\t\t

\n\t\t\tFor information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch,\n\t\t\tgo to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference\n\t\t\tin the Amazon CloudWatch Developer Guide.\n\t\t

" + }, + "ListMetrics":{ + "name":"ListMetrics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMetricsInput"}, + "output":{ + "shape":"ListMetricsOutput", + "documentation":"

\n\t\tThe output for the ListMetrics action.\n\t\t

", + "xmlOrder":[ + "Metrics", + "NextToken" + ], + "resultWrapper":"ListMetricsResult" + }, + "errors":[ + { + "shape":"InternalServiceFault", + "error":{ + "code":"InternalServiceError", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

\n\t\tIndicates that the request processing has\n\t\tfailed due to some unknown error, exception, or failure.\n\t\t

", + "xmlOrder":["Message"] + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tBad or out-of-range value was supplied for the input\n\t\tparameter.\n\t\t

" + } + ], + "documentation":"

\n\t\tReturns a list of valid metrics stored for the AWS account owner.\n\t\tReturned metrics can be used with GetMetricStatistics\n\t\tto obtain statistical data for a given metric.\n\t\t

\n\t\t\n\t\tUp to 500 results are returned for any one call. To retrieve further\n\t\tresults, use returned NextToken values with subsequent\n\t\tListMetrics operations.\n\t\t\n\t\t\n\t\t\tIf you create a metric with the PutMetricData action,\n\t\t\tallow up to fifteen minutes for the metric to appear in calls\n\t\t\tto the ListMetrics action. Statistics about the metric, \n\t\t\thowever, are available sooner using GetMetricStatistics.\n\t\t" + }, + "PutMetricAlarm":{ + "name":"PutMetricAlarm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricAlarmInput"}, + "errors":[ + { + "shape":"LimitExceededFault", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tThe quota for alarms for this customer has\n\t\talready been reached.\n\t\t

" + } + ], + "documentation":"

\n\t\tCreates or updates an alarm and associates it\n\t\twith the specified Amazon CloudWatch metric. Optionally,\n\t\tthis operation can associate one or more Amazon Simple\n\t\tNotification Service resources with the alarm.\n\t\t

\n\t\t

\n\t\tWhen this operation creates an alarm, the alarm state is immediately\n\t\tset to INSUFFICIENT_DATA. The alarm is evaluated and its\n\t\tStateValue is set appropriately. Any actions associated\n\t\twith the StateValue is then executed.\n\t\t

\n\t\t\n\t\tWhen updating an existing alarm, its StateValue\n\t\tis left unchanged.\n\t\t" + }, + "PutMetricData":{ + "name":"PutMetricData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricDataInput"}, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tBad or out-of-range value was supplied for the input\n\t\tparameter.\n\t\t

" + }, + { + "shape":"MissingRequiredParameterException", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tAn input parameter that is mandatory for processing\n\t\tthe request is not supplied.\n\t\t

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tParameters that must not be used together were\n\t\tused together.\n\t\t

" + }, + { + "shape":"InternalServiceFault", + "error":{ + "code":"InternalServiceError", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

\n\t\tIndicates that the request processing has\n\t\tfailed due to some unknown error, exception, or failure.\n\t\t

", + "xmlOrder":["Message"] + } + ], + "documentation":"

\n\t\tPublishes metric data points to Amazon CloudWatch. Amazon Cloudwatch\n\t\tassociates the data points with the specified metric. If the specified metric does not exist,\n\t\tAmazon CloudWatch creates the metric. It can take up to fifteen minutes for a new metric to appear\n\t\tin calls to the ListMetrics action.

\n\n\t\t

\n\t\t\tThe size of a PutMetricData request is limited to 8 KB\n\t\t\tfor HTTP GET requests and 40 KB for HTTP POST requests.\n\t\t

\n\t\t\n\t\t\tAlthough the Value parameter accepts numbers of type Double,\n\t\t\tAmazon CloudWatch truncates values with very large exponents.\n\t\t\tValues with base-10 exponents greater than 126 (1 x 10^126) are truncated.\n\t\t\tLikewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.\n\t\t\n\t\t\n\t\t

Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become\n\t\t\tavailable from submission time using GetMetricStatistics.

\n\n\t\t\n\t\t\t\nThe following example puts data for a single metric containing one dimension:\n\nhttps://monitoring.amazonaws.com/doc/2010-08-01/\n?Action=PutMetricData\n&Version=2010-08-01\n&Namespace=TestNamespace\n&MetricData.member.1.MetricName=buffers\n&MetricData.member.1.Unit=Bytes\n&MetricData.member.1.Value=231434333\n&MetricData.member.1.Dimensions.member.1.Name=InstanceType\n&MetricData.member.1.Dimensions.member.1.Value=m1.small\n&AUTHPARAMS\n\n\nThe following example puts data for a single metric containing two dimensions:\n\nhttps://monitoring.amazonaws.com/doc/2010-08-01/\n?Action=PutMetricData\n&Version=2010-08-01\n&Namespace=TestNamespace\n&MetricData.member.1.MetricName=buffers\n&MetricData.member.1.Unit=Bytes\n&MetricData.member.1.Value=231434333\n&MetricData.member.1.Dimensions.member.1.Name=InstanceID\n&MetricData.member.1.Dimensions.member.1.Value=i-aaba32d4\n&MetricData.member.1.Dimensions.member.2.Name=InstanceType\n&MetricData.member.1.Dimensions.member.2.Value=m1.small\n&AUTHPARAMS\n\n\nThe following example puts data for two metrics, each with two dimensions:\n\nhttps://monitoring.amazonaws.com/doc/2010-08-01/\n?Action=PutMetricData\n&Version=2010-08-01\n&Namespace=TestNamespace\n&MetricData.member.1.MetricName=buffers\n&MetricData.member.1.Unit=Bytes\n&MetricData.member.1.Value=231434333\n&MetricData.member.1.Dimensions.member.1.Name=InstanceID\n&MetricData.member.1.Dimensions.member.1.Value=i-aaba32d4\n&MetricData.member.1.Dimensions.member.2.Name=InstanceType\n&MetricData.member.1.Dimensions.member.2.Value=m1.small\n&MetricData.member.2.MetricName=latency\n&MetricData.member.2.Unit=Milliseconds\n&MetricData.member.2.Value=23\n&MetricData.member.2.Dimensions.member.1.Name=InstanceID\n&MetricData.member.2.Dimensions.member.1.Value=i-aaba32d4\n&MetricData.member.2.Dimensions.member.2.Name=InstanceType\n&MetricData.member.2.Dimensions.member.2.Value=m1.small\n&AUTHPARAMS\n\t\t\t\n\t\t\t\n\n \n e16fc4d3-9a04-11e0-9362-093a1cae5385\n \n \n\t\t\t\n\t\t" + }, + "SetAlarmState":{ + "name":"SetAlarmState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetAlarmStateInput"}, + "errors":[ + { + "shape":"ResourceNotFound", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tThe named resource does not exist.\n\t\t

" + }, + { + "shape":"InvalidFormatFault", + "error":{ + "code":"InvalidFormat", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tData was not syntactically valid JSON.\n\t\t

" + } + ], + "documentation":"

\n\t\tTemporarily sets the state of an alarm.\n\t\tWhen the updated StateValue differs\n\t\tfrom the previous value, the action configured for\n\t\tthe appropriate state is invoked. This is not a\n\t\tpermanent change. The next periodic alarm check\n\t\t(in about a minute) will set the alarm to its actual state.\n\t\t

" + } + }, + "shapes":{ + "ActionPrefix":{ + "type":"string", + "min":1, + "max":1024 + }, + "ActionsEnabled":{"type":"boolean"}, + "AlarmArn":{ + "type":"string", + "min":1, + "max":1600 + }, + "AlarmDescription":{ + "type":"string", + "min":0, + "max":255 + }, + "AlarmHistoryItem":{ + "type":"structure", + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

\n\t\tThe descriptive name for the alarm.\n\t\t

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\t\tThe time stamp for the alarm history item. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.\n\t\t

" + }, + "HistoryItemType":{ + "shape":"HistoryItemType", + "documentation":"

\n\t\tThe type of alarm history item.\n\t\t

" + }, + "HistorySummary":{ + "shape":"HistorySummary", + "documentation":"

\n\t\tA human-readable summary of the alarm history.\n\t\t

" + }, + "HistoryData":{ + "shape":"HistoryData", + "documentation":"

\n\t\tMachine-readable data about the alarm in JSON format.\n\t\t

" + } + }, + "documentation":"

\n\t\t\tThe AlarmHistoryItem data type\n\t\t\tcontains descriptive information about\n\t\t\tthe history of a specific alarm.\n\t\t\tIf you call DescribeAlarmHistory,\n\t\t\tAmazon CloudWatch returns this data type as part of\n\t\t\tthe DescribeAlarmHistoryResult data type.\n\t\t

" + }, + "AlarmHistoryItems":{ + "type":"list", + "member":{"shape":"AlarmHistoryItem"} + }, + "AlarmName":{ + "type":"string", + "min":1, + "max":255 + }, + "AlarmNamePrefix":{ + "type":"string", + "min":1, + "max":255 + }, + "AlarmNames":{ + "type":"list", + "member":{"shape":"AlarmName"}, + "max":100 + }, + "AwsQueryErrorMessage":{"type":"string"}, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold" + ] + }, + "Datapoint":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\t\tThe time stamp used for the datapoint. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.\n\t\t

" + }, + "SampleCount":{ + "shape":"DatapointValue", + "documentation":"

\n\t\tThe number of metric values that contributed to the aggregate value\n\t\tof this datapoint.\n\t\t

" + }, + "Average":{ + "shape":"DatapointValue", + "documentation":"

\n\t\tThe average of metric values that correspond to the datapoint.\n\t\t

" + }, + "Sum":{ + "shape":"DatapointValue", + "documentation":"

\n\t\tThe sum of metric values used for the datapoint.\n\t\t

" + }, + "Minimum":{ + "shape":"DatapointValue", + "documentation":"

\n\t\tThe minimum metric value used for the datapoint.\n\t\t

" + }, + "Maximum":{ + "shape":"DatapointValue", + "documentation":"

\n\t\tThe maximum of the metric value used for the datapoint.\n\t\t

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

\n\t\tThe standard unit used for the datapoint.\n\t\t

" + } + }, + "documentation":"

\n\t\tThe Datapoint data type encapsulates the statistical data\n\t\tthat Amazon CloudWatch computes from metric data.\n\t\t

", + "xmlOrder":[ + "Timestamp", + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum", + "Unit" + ] + }, + "DatapointValue":{"type":"double"}, + "Datapoints":{ + "type":"list", + "member":{"shape":"Datapoint"} + }, + "DeleteAlarmsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{ + "shape":"AlarmNames", + "documentation":"

\n\t\tA list of alarms to be deleted.\n\t\t

" + } + } + }, + "DescribeAlarmHistoryInput":{ + "type":"structure", + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

\n\t\tThe name of the alarm.\n\t\t

" + }, + "HistoryItemType":{ + "shape":"HistoryItemType", + "documentation":"

\n\t\tThe type of alarm histories to retrieve.\n\t\t

" + }, + "StartDate":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe starting date to retrieve alarm history.\n\t\t

" + }, + "EndDate":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe ending date to retrieve alarm history.\n\t\t

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

\n\t\tThe maximum number of alarm history records to retrieve.\n\t\t

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

\n\t\tThe token returned by a previous call to indicate that there\n\t\tis more data available.\n\t\t

" + } + } + }, + "DescribeAlarmHistoryOutput":{ + "type":"structure", + "members":{ + "AlarmHistoryItems":{ + "shape":"AlarmHistoryItems", + "documentation":"

\n\t\tA list of alarm histories in JSON format.\n\t\t

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

\n\t\tA string that marks the start of the next batch of returned results.\n\t\t

" + } + }, + "documentation":"

\n\t\tThe output for the DescribeAlarmHistory action.\n\t\t

" + }, + "DescribeAlarmsForMetricInput":{ + "type":"structure", + "required":[ + "MetricName", + "Namespace" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

\n\t\tThe name of the metric.\n\t\t

" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

\n\t\tThe namespace of the metric.\n\t\t

" + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

\n\t\tThe statistic for the metric.\n\t\t

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

\n\t\tThe list of dimensions associated with the metric.\n\t\t

" + }, + "Period":{ + "shape":"Period", + "documentation":"

\n\t\tThe period in seconds over which the statistic is applied.\n\t\t

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

\n\t\tThe unit for the metric.\n\t\t

" + } + } + }, + "DescribeAlarmsForMetricOutput":{ + "type":"structure", + "members":{ + "MetricAlarms":{ + "shape":"MetricAlarms", + "documentation":"

\n\t\tA list of information for each alarm with the specified metric.\n\t\t

" + } + }, + "documentation":"

\n\t\tThe output for the DescribeAlarmsForMetric action.\n\t\t

" + }, + "DescribeAlarmsInput":{ + "type":"structure", + "members":{ + "AlarmNames":{ + "shape":"AlarmNames", + "documentation":"

\n\t\tA list of alarm names to retrieve information for.\n\t\t

" + }, + "AlarmNamePrefix":{ + "shape":"AlarmNamePrefix", + "documentation":"

\n\t\tThe alarm name prefix. AlarmNames cannot\n\t\tbe specified if this parameter is specified.\n\t\t

" + }, + "StateValue":{ + "shape":"StateValue", + "documentation":"

\n\t\tThe state value to be used in matching alarms.\n\t\t

" + }, + "ActionPrefix":{ + "shape":"ActionPrefix", + "documentation":"

\n\t\tThe action name prefix.\n\t\t

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

\n\t\tThe maximum number of alarm descriptions to retrieve.\n\t\t

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

\n\t\tThe token returned by a previous call to indicate that there\n\t\tis more data available.\n\t\t

" + } + } + }, + "DescribeAlarmsOutput":{ + "type":"structure", + "members":{ + "MetricAlarms":{ + "shape":"MetricAlarms", + "documentation":"

\n\t\tA list of information for the specified alarms.\n\t\t

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

\n\t\tA string that marks the start of the next batch of returned results.\n\t\t

" + } + }, + "documentation":"

\n\t\tThe output for the DescribeAlarms action.\n\t\t

" + }, + "Dimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"DimensionName", + "documentation":"

\n\t\tThe name of the dimension.\n\t\t

" + }, + "Value":{ + "shape":"DimensionValue", + "documentation":"

\n\t\tThe value representing the dimension measurement\n\t\t

" + } + }, + "documentation":"

\n\t\tThe Dimension data type further expands on the\n\t\tidentity of a metric using a Name, Value pair.\n\t\t

\n\t\t

For examples that use one or more dimensions, see PutMetricData.

", + "xmlOrder":[ + "Name", + "Value" + ] + }, + "DimensionFilter":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DimensionName", + "documentation":"

\n\t\tThe dimension name to be matched.\n\t\t

" + }, + "Value":{ + "shape":"DimensionValue", + "documentation":"

\n\t\tThe value of the dimension to be matched.\n\t\t

\n\t\t\n\t\tSpecifying a Name without specifying a\n\t\tValue returns all values associated\n\t\twith that Name.\n\t\t" + } + }, + "documentation":"

\n\t\tThe DimensionFilter data type is used to filter\n\t\tListMetrics results.\n\t\t

" + }, + "DimensionFilters":{ + "type":"list", + "member":{"shape":"DimensionFilter"}, + "max":10 + }, + "DimensionName":{ + "type":"string", + "min":1, + "max":255 + }, + "DimensionValue":{ + "type":"string", + "min":1, + "max":255 + }, + "Dimensions":{ + "type":"list", + "member":{"shape":"Dimension"}, + "max":10 + }, + "DisableAlarmActionsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{ + "shape":"AlarmNames", + "documentation":"

\n\t\tThe names of the alarms to disable actions for.\n\t\t

" + } + }, + "documentation":"

\n\n\t\t

" + }, + "EnableAlarmActionsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{ + "shape":"AlarmNames", + "documentation":"

\n\t\tThe names of the alarms to enable actions for.\n\t\t

" + } + } + }, + "ErrorMessage":{ + "type":"string", + "min":1, + "max":255 + }, + "EvaluationPeriods":{ + "type":"integer", + "min":1 + }, + "FaultDescription":{"type":"string"}, + "GetMetricStatisticsInput":{ + "type":"structure", + "required":[ + "Namespace", + "MetricName", + "StartTime", + "EndTime", + "Period", + "Statistics" + ], + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

\n\t\tThe namespace of the metric, with or without spaces.\n\t\t

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

\n\t\tThe name of the metric, with or without spaces.\n\t\t

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

\n\t\tA list of dimensions describing qualities of the metric.\n\t\t

" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe time stamp to use for determining the first datapoint to return.\n\t\tThe value specified is inclusive; results include datapoints\n\t\twith the time stamp specified.\n\t\t

\n\t\t\n\t\tThe specified start time is rounded down to the nearest value.\n\t\tDatapoints are returned for start times up to two weeks in the past.\n\t\tSpecified start times that are more than two weeks in the past\n\t\twill not return datapoints for metrics that are\n\t\tolder than two weeks.\n\t\t\n\t\t

Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.

\n\t\t\t\n\t\t" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe time stamp to use for determining the last\n\t\tdatapoint to return. The value specified is exclusive;\n\t\tresults will include datapoints up to the time stamp\n\t\tspecified.\n\t\t

" + }, + "Period":{ + "shape":"Period", + "documentation":"

\n\t\tThe granularity, in seconds, of the returned datapoints.\n\t\tPeriod must be at least 60 seconds and\n\t\tmust be a multiple of 60. The default value is 60.\n\t\t

" + }, + "Statistics":{ + "shape":"Statistics", + "documentation":"

\n\t\t\tThe metric statistics to return. For information about specific statistics \n\t\t\treturned by GetMetricStatistics, go to Statistics in the Amazon CloudWatch Developer Guide. \n\t\t

\n\t\t

\n\t\t\tValid Values: Average | Sum | SampleCount | Maximum | Minimum\n\t\t

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

\n\t\tThe unit for the metric.\n\t\t

" + } + } + }, + "GetMetricStatisticsOutput":{ + "type":"structure", + "members":{ + "Label":{ + "shape":"MetricLabel", + "documentation":"

\n\t\tA label describing the specified metric.\n\t\t

" + }, + "Datapoints":{ + "shape":"Datapoints", + "documentation":"

\n\t\tThe datapoints for the specified metric.\n\t\t

" + } + }, + "documentation":"

\n\t\tThe output for the GetMetricStatistics action.\n\t\t

" + }, + "HistoryData":{ + "type":"string", + "min":1, + "max":4095 + }, + "HistoryItemType":{ + "type":"string", + "enum":[ + "ConfigurationUpdate", + "StateUpdate", + "Action" + ] + }, + "HistorySummary":{ + "type":"string", + "min":1, + "max":255 + }, + "InternalServiceFault":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"FaultDescription", + "documentation":"

" + } + }, + "error":{ + "code":"InternalServiceError", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

\n\t\tIndicates that the request processing has\n\t\tfailed due to some unknown error, exception, or failure.\n\t\t

", + "xmlOrder":["Message"] + }, + "InvalidFormatFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "error":{ + "code":"InvalidFormat", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tData was not syntactically valid JSON.\n\t\t

" + }, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tThe next token specified is invalid.\n\t\t

" + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

" + } + }, + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tParameters that must not be used together were\n\t\tused together.\n\t\t

" + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

" + } + }, + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tBad or out-of-range value was supplied for the input\n\t\tparameter.\n\t\t

" + }, + "LimitExceededFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tThe quota for alarms for this customer has\n\t\talready been reached.\n\t\t

" + }, + "ListMetricsInput":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

\n\t\tThe namespace to filter against.\n\t\t

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

\n\t\tThe name of the metric to filter against.\n\t\t

" + }, + "Dimensions":{ + "shape":"DimensionFilters", + "documentation":"

\n\t\tA list of dimensions to filter against.\n\t\t

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

\n\t\tThe token returned by a previous call to indicate that there\n\t\tis more data available.\n\t\t

" + } + } + }, + "ListMetricsOutput":{ + "type":"structure", + "members":{ + "Metrics":{ + "shape":"Metrics", + "documentation":"

\n\t\tA list of metrics used to generate statistics for an AWS account.\n\t\t

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

\n\t\tA string that marks the start of the next batch of returned results.\n\t\t

" + } + }, + "documentation":"

\n\t\tThe output for the ListMetrics action.\n\t\t

", + "xmlOrder":[ + "Metrics", + "NextToken" + ] + }, + "MaxRecords":{ + "type":"integer", + "min":1, + "max":100 + }, + "Metric":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

\n\t\tThe namespace of the metric.\n\t\t

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

\n\t\tThe name of the metric.\n\t\t

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

\n\t\tA list of dimensions associated with the metric.\n\t\t

" + } + }, + "documentation":"

\n\t\tThe Metric data type contains\n\t\tinformation about a specific metric. If you call\n\t\tListMetrics, Amazon CloudWatch returns\n\t\tinformation contained by this data type.\n\t\t

\n\t\t

\n\t\t\tThe example in the Examples section publishes two metrics named buffers and latency. \n\t\t\tBoth metrics are in the examples namespace. Both metrics have two dimensions, InstanceID and InstanceType.\n\t\t

", + "xmlOrder":[ + "Namespace", + "MetricName", + "Dimensions" + ] + }, + "MetricAlarm":{ + "type":"structure", + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

\n\t\tThe name of the alarm.\n\t\t

" + }, + "AlarmArn":{ + "shape":"AlarmArn", + "documentation":"

\n\t\tThe Amazon Resource Name (ARN) of the alarm.\n\t\t

" + }, + "AlarmDescription":{ + "shape":"AlarmDescription", + "documentation":"

\n\t\tThe description for the alarm.\n\t\t

" + }, + "AlarmConfigurationUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\t\tThe time stamp of the last update to the alarm configuration. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.\n\t\t

" + }, + "ActionsEnabled":{ + "shape":"ActionsEnabled", + "documentation":"

\n\t\tIndicates whether actions should be executed\n\t\tduring any changes to the alarm's state.\n\t\t

" + }, + "OKActions":{ + "shape":"ResourceList", + "documentation":"

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an OK state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic and triggering an Auto Scaling policy.\n\t\t

" + }, + "AlarmActions":{ + "shape":"ResourceList", + "documentation":"

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an ALARM state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic and triggering an Auto Scaling policy.\n\t\t

" + }, + "InsufficientDataActions":{ + "shape":"ResourceList", + "documentation":"

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an INSUFFICIENT_DATA state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic or triggering an Auto Scaling policy.\n\t\t

\n\t\tThe current WSDL lists this attribute as UnknownActions." + }, + "StateValue":{ + "shape":"StateValue", + "documentation":"

\n\t\tThe state value for the alarm.\n\t\t

" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

\n\t\tA human-readable explanation for the alarm's state.\n\t\t

" + }, + "StateReasonData":{ + "shape":"StateReasonData", + "documentation":"

\n\t\tAn explanation for the alarm's state in machine-readable JSON format\n\t\t

" + }, + "StateUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\t\tThe time stamp of the last update to the alarm's state. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.\n\t\t

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

\n\t\tThe name of the alarm's metric.\n\t\t

" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

\n\t\tThe namespace of alarm's associated metric.\n\t\t

" + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

\n\t\tThe statistic to apply to the alarm's associated metric.\n\t\t

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

\n\t\tThe list of dimensions associated with the alarm's associated metric.\n\t\t

" + }, + "Period":{ + "shape":"Period", + "documentation":"

\n\t\tThe period in seconds over which the statistic is applied.\n\t\t

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

\n\t\tThe unit of the alarm's associated metric.\n\t\t

" + }, + "EvaluationPeriods":{ + "shape":"EvaluationPeriods", + "documentation":"

\n\t\tThe number of periods over which data is compared to the\n\t\tspecified threshold.\n\t\t

" + }, + "Threshold":{ + "shape":"Threshold", + "documentation":"

\n\t\tThe value against which the specified statistic is compared.\n\t\t

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

\n\t\tThe arithmetic operation to use when comparing the specified\n\t\tStatistic and Threshold. The specified\n\t\tStatistic value is used as the first operand.\n\t\t

" + } + }, + "documentation":"

\n\t\tThe MetricAlarm data type represents\n\t\tan alarm. You can use PutMetricAlarm\n\t\tto create or update an alarm.\n\t\t

", + "xmlOrder":[ + "AlarmName", + "AlarmArn", + "AlarmDescription", + "AlarmConfigurationUpdatedTimestamp", + "ActionsEnabled", + "OKActions", + "AlarmActions", + "InsufficientDataActions", + "StateValue", + "StateReason", + "StateReasonData", + "StateUpdatedTimestamp", + "MetricName", + "Namespace", + "Statistic", + "Dimensions", + "Period", + "Unit", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator" + ] + }, + "MetricAlarms":{ + "type":"list", + "member":{"shape":"MetricAlarm"} + }, + "MetricData":{ + "type":"list", + "member":{"shape":"MetricDatum"} + }, + "MetricDatum":{ + "type":"structure", + "required":["MetricName"], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

\n\t\t\tThe name of the metric.\n\t\t

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

\n\t\t\tA list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).\n\t\t

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\t\tThe time stamp used for the metric. If not specified, the default value is set to the time the metric data was received. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.\n\t\t

" + }, + "Value":{ + "shape":"DatapointValue", + "documentation":"

\n\t\t\tThe value for the metric.\n\t\t

\n\t\tAlthough the Value parameter accepts numbers of type Double,\n\t\t\tAmazon CloudWatch truncates values with very large exponents.\n\t\t\tValues with base-10 exponents greater than 126 (1 x 10^126) are truncated.\n\t\t\tLikewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.\n\t\t" + }, + "StatisticValues":{ + "shape":"StatisticSet", + "documentation":"

\n\t\t\tA set of statistical values describing the metric.\n\t\t

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

\n\t\t\tThe unit of the metric.\n\t\t

" + } + }, + "documentation":"

\n\t\t\tThe MetricDatum data type encapsulates the information\n\t\t\tsent with PutMetricData to either create a new metric or\n\t\t\tadd new values to be aggregated into an existing metric.\n\t\t

" + }, + "MetricLabel":{"type":"string"}, + "MetricName":{ + "type":"string", + "min":1, + "max":255 + }, + "Metrics":{ + "type":"list", + "member":{"shape":"Metric"} + }, + "MissingRequiredParameterException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

" + } + }, + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tAn input parameter that is mandatory for processing\n\t\tthe request is not supplied.\n\t\t

" + }, + "Namespace":{ + "type":"string", + "min":1, + "max":255, + "pattern":"[^:].*" + }, + "NextToken":{"type":"string"}, + "Period":{ + "type":"integer", + "min":60 + }, + "PutMetricAlarmInput":{ + "type":"structure", + "required":[ + "AlarmName", + "MetricName", + "Namespace", + "Statistic", + "Period", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator" + ], + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

\n\t\tThe descriptive name for the alarm. This name\n\t\tmust be unique within the user's AWS account\n\t\t

" + }, + "AlarmDescription":{ + "shape":"AlarmDescription", + "documentation":"

\n\t\tThe description for the alarm.\n\t\t

" + }, + "ActionsEnabled":{ + "shape":"ActionsEnabled", + "documentation":"

\n\t\tIndicates whether or not actions should be executed\n\t\tduring any changes to the alarm's state.\n\t\t

" + }, + "OKActions":{ + "shape":"ResourceList", + "documentation":"

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an OK state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only action supported is publishing\n\t\tto an Amazon SNS topic or an Amazon Auto Scaling policy.\n\t\t

" + }, + "AlarmActions":{ + "shape":"ResourceList", + "documentation":"

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an ALARM state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only action supported is publishing\n\t\tto an Amazon SNS topic or an Amazon Auto Scaling policy.\n\t\t

" + }, + "InsufficientDataActions":{ + "shape":"ResourceList", + "documentation":"

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an INSUFFICIENT_DATA state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only action supported is publishing\n\t\tto an Amazon SNS topic or an Amazon Auto Scaling policy.\n\t\t

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

\n\t\tThe name for the alarm's associated metric.\n\t\t

" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

\n\t\tThe namespace for the alarm's associated metric.\n\t\t

" + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

\n\t\tThe statistic to apply to the alarm's associated metric.\n\t\t

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

\n\t\tThe dimensions for the alarm's associated metric.\n\t\t

" + }, + "Period":{ + "shape":"Period", + "documentation":"

\n\t\tThe period in seconds over which the specified statistic\n\t\tis applied.\n\t\t

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

\n\t\tThe unit for the alarm's associated metric.\n\t\t

" + }, + "EvaluationPeriods":{ + "shape":"EvaluationPeriods", + "documentation":"

\n\t\tThe number of periods over which data is compared to the\n\t\tspecified threshold.\n\t\t

" + }, + "Threshold":{ + "shape":"Threshold", + "documentation":"

\n\t\tThe value against which the specified statistic is compared.\n\t\t

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

\n\t\tThe arithmetic operation to use when comparing the specified\n\t\tStatistic and Threshold. The specified\n\t\tStatistic value is used as the first operand.\n\t\t

" + } + } + }, + "PutMetricDataInput":{ + "type":"structure", + "required":[ + "Namespace", + "MetricData" + ], + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

\n\t\tThe namespace for the metric data.\n\t\t

\n\t\t\n\t\t\tYou cannot specify a namespace that begins with \"AWS/\".\n\t\t\tNamespaces that begin with \"AWS/\" are reserved for \n\t\t\tother Amazon Web Services products that send metrics to Amazon CloudWatch.\n\t\t" + }, + "MetricData":{ + "shape":"MetricData", + "documentation":"

\n\t\tA list of data describing the metric.\n\t\t

" + } + } + }, + "ResourceList":{ + "type":"list", + "member":{"shape":"ResourceName"}, + "max":5 + }, + "ResourceName":{ + "type":"string", + "min":1, + "max":1024 + }, + "ResourceNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n\t\tThe named resource does not exist.\n\t\t

" + }, + "SetAlarmStateInput":{ + "type":"structure", + "required":[ + "AlarmName", + "StateValue", + "StateReason" + ], + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

\n\t\tThe descriptive name for the alarm. This name\n\t\tmust be unique within the user's AWS account.\n\t\tThe maximum length is 255 characters.\n\t\t

" + }, + "StateValue":{ + "shape":"StateValue", + "documentation":"

\n\t\t\tThe value of the state.\n\t\t

" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

\n\t\tThe reason that this alarm is set to this specific state (in human-readable text format)\n\t\t

" + }, + "StateReasonData":{ + "shape":"StateReasonData", + "documentation":"

\n\t\tThe reason that this alarm is set to this specific state (in machine-readable JSON format)\n\t\t

" + } + } + }, + "StandardUnit":{ + "type":"string", + "enum":[ + "Seconds", + "Microseconds", + "Milliseconds", + "Bytes", + "Kilobytes", + "Megabytes", + "Gigabytes", + "Terabytes", + "Bits", + "Kilobits", + "Megabits", + "Gigabits", + "Terabits", + "Percent", + "Count", + "Bytes/Second", + "Kilobytes/Second", + "Megabytes/Second", + "Gigabytes/Second", + "Terabytes/Second", + "Bits/Second", + "Kilobits/Second", + "Megabits/Second", + "Gigabits/Second", + "Terabits/Second", + "Count/Second", + "None" + ] + }, + "StateReason":{ + "type":"string", + "min":0, + "max":1023 + }, + "StateReasonData":{ + "type":"string", + "min":0, + "max":4000 + }, + "StateValue":{ + "type":"string", + "enum":[ + "OK", + "ALARM", + "INSUFFICIENT_DATA" + ] + }, + "Statistic":{ + "type":"string", + "enum":[ + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum" + ] + }, + "StatisticSet":{ + "type":"structure", + "required":[ + "SampleCount", + "Sum", + "Minimum", + "Maximum" + ], + "members":{ + "SampleCount":{ + "shape":"DatapointValue", + "documentation":"

\n\t\t\tThe number of samples used for the statistic set.\n\t\t

" + }, + "Sum":{ + "shape":"DatapointValue", + "documentation":"

\n\t\t\tThe sum of values for the sample set.\n\t\t

" + }, + "Minimum":{ + "shape":"DatapointValue", + "documentation":"

\n\t\t\tThe minimum value of the sample set.\n\t\t

" + }, + "Maximum":{ + "shape":"DatapointValue", + "documentation":"

\n\t\t\tThe maximum value of the sample set.\n\t\t

" + } + }, + "documentation":"

\n\t\t\tThe StatisticSet data type\n\t\t\tdescribes the StatisticValues\n\t\t\tcomponent of MetricDatum, and represents a set of\n\t\t\tstatistics that describes a specific metric.\n\t\t

" + }, + "Statistics":{ + "type":"list", + "member":{"shape":"Statistic"}, + "min":1, + "max":5 + }, + "Threshold":{"type":"double"}, + "Timestamp":{"type":"timestamp"} + } +} diff --git a/apis/monitoring-2010-08-01.paginators.json b/apis/monitoring-2010-08-01.paginators.json new file mode 100644 index 0000000000..7bee28c28f --- /dev/null +++ b/apis/monitoring-2010-08-01.paginators.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "DescribeAlarmHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "AlarmHistoryItems" + }, + "DescribeAlarms": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "MetricAlarms" + }, + "DescribeAlarmsForMetric": { + "result_key": "MetricAlarms" + }, + "ListMetrics": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Metrics" + } + } +} diff --git a/apis/opsworks-2013-02-18.api.json b/apis/opsworks-2013-02-18.api.json new file mode 100644 index 0000000000..522676ca52 --- /dev/null +++ b/apis/opsworks-2013-02-18.api.json @@ -0,0 +1,1826 @@ +{ + "metadata": { + "apiVersion": "2013-02-18", + "endpointPrefix": "opsworks", + "jsonVersion": "1.1", + "serviceFullName": "AWS OpsWorks", + "signatureVersion": "v4", + "targetPrefix": "OpsWorks_20130218", + "protocol": "json" + }, + "operations": { + "AssignVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {}, + "InstanceId": {} + } + } + }, + "AssociateElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp" + ], + "members": { + "ElasticIp": {}, + "InstanceId": {} + } + } + }, + "AttachElasticLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "ElasticLoadBalancerName", + "LayerId" + ], + "members": { + "ElasticLoadBalancerName": {}, + "LayerId": {} + } + } + }, + "CloneStack": { + "input": { + "type": "structure", + "required": [ + "SourceStackId", + "ServiceRoleArn" + ], + "members": { + "SourceStackId": {}, + "Name": {}, + "Region": {}, + "VpcId": {}, + "Attributes": { + "shape": "S6" + }, + "ServiceRoleArn": {}, + "DefaultInstanceProfileArn": {}, + "DefaultOs": {}, + "HostnameTheme": {}, + "DefaultAvailabilityZone": {}, + "DefaultSubnetId": {}, + "CustomJson": {}, + "ConfigurationManager": { + "shape": "S8" + }, + "ChefConfiguration": { + "shape": "S9" + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "UseOpsworksSecurityGroups": { + "type": "boolean" + }, + "CustomCookbooksSource": { + "shape": "Sb" + }, + "DefaultSshKeyName": {}, + "ClonePermissions": { + "type": "boolean" + }, + "CloneAppIds": { + "shape": "Sd" + }, + "DefaultRootDeviceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "CreateApp": { + "input": { + "type": "structure", + "required": [ + "StackId", + "Name", + "Type" + ], + "members": { + "StackId": {}, + "Shortname": {}, + "Name": {}, + "Description": {}, + "DataSources": { + "shape": "Sh" + }, + "Type": {}, + "AppSource": { + "shape": "Sb" + }, + "Domains": { + "shape": "Sd" + }, + "EnableSsl": { + "type": "boolean" + }, + "SslConfiguration": { + "shape": "Sk" + }, + "Attributes": { + "shape": "Sl" + }, + "Environment": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "members": { + "AppId": {} + } + } + }, + "CreateDeployment": { + "input": { + "type": "structure", + "required": [ + "StackId", + "Command" + ], + "members": { + "StackId": {}, + "AppId": {}, + "InstanceIds": { + "shape": "Sd" + }, + "Command": { + "shape": "Sr" + }, + "Comment": {}, + "CustomJson": {} + } + }, + "output": { + "type": "structure", + "members": { + "DeploymentId": {} + } + } + }, + "CreateInstance": { + "input": { + "type": "structure", + "required": [ + "StackId", + "LayerIds", + "InstanceType" + ], + "members": { + "StackId": {}, + "LayerIds": { + "shape": "Sd" + }, + "InstanceType": {}, + "AutoScalingType": {}, + "Hostname": {}, + "Os": {}, + "AmiId": {}, + "SshKeyName": {}, + "AvailabilityZone": {}, + "VirtualizationType": {}, + "SubnetId": {}, + "Architecture": {}, + "RootDeviceType": {}, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "EbsOptimized": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceId": {} + } + } + }, + "CreateLayer": { + "input": { + "type": "structure", + "required": [ + "StackId", + "Type", + "Name", + "Shortname" + ], + "members": { + "StackId": {}, + "Type": {}, + "Name": {}, + "Shortname": {}, + "Attributes": { + "shape": "S11" + }, + "CustomInstanceProfileArn": {}, + "CustomSecurityGroupIds": { + "shape": "Sd" + }, + "Packages": { + "shape": "Sd" + }, + "VolumeConfigurations": { + "shape": "S13" + }, + "EnableAutoHealing": { + "type": "boolean" + }, + "AutoAssignElasticIps": { + "type": "boolean" + }, + "AutoAssignPublicIps": { + "type": "boolean" + }, + "CustomRecipes": { + "shape": "S16" + }, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "UseEbsOptimizedInstances": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LayerId": {} + } + } + }, + "CreateStack": { + "input": { + "type": "structure", + "required": [ + "Name", + "Region", + "ServiceRoleArn", + "DefaultInstanceProfileArn" + ], + "members": { + "Name": {}, + "Region": {}, + "VpcId": {}, + "Attributes": { + "shape": "S6" + }, + "ServiceRoleArn": {}, + "DefaultInstanceProfileArn": {}, + "DefaultOs": {}, + "HostnameTheme": {}, + "DefaultAvailabilityZone": {}, + "DefaultSubnetId": {}, + "CustomJson": {}, + "ConfigurationManager": { + "shape": "S8" + }, + "ChefConfiguration": { + "shape": "S9" + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "UseOpsworksSecurityGroups": { + "type": "boolean" + }, + "CustomCookbooksSource": { + "shape": "Sb" + }, + "DefaultSshKeyName": {}, + "DefaultRootDeviceType": {} + } + }, + "output": { + "type": "structure", + "members": { + "StackId": {} + } + } + }, + "CreateUserProfile": { + "input": { + "type": "structure", + "required": [ + "IamUserArn" + ], + "members": { + "IamUserArn": {}, + "SshUsername": {}, + "SshPublicKey": {}, + "AllowSelfManagement": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "IamUserArn": {} + } + } + }, + "DeleteApp": { + "input": { + "type": "structure", + "required": [ + "AppId" + ], + "members": { + "AppId": {} + } + } + }, + "DeleteInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "DeleteElasticIp": { + "type": "boolean" + }, + "DeleteVolumes": { + "type": "boolean" + } + } + } + }, + "DeleteLayer": { + "input": { + "type": "structure", + "required": [ + "LayerId" + ], + "members": { + "LayerId": {} + } + } + }, + "DeleteStack": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + } + }, + "DeleteUserProfile": { + "input": { + "type": "structure", + "required": [ + "IamUserArn" + ], + "members": { + "IamUserArn": {} + } + } + }, + "DeregisterElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp" + ], + "members": { + "ElasticIp": {} + } + } + }, + "DeregisterRdsDbInstance": { + "input": { + "type": "structure", + "required": [ + "RdsDbInstanceArn" + ], + "members": { + "RdsDbInstanceArn": {} + } + } + }, + "DeregisterVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {} + } + } + }, + "DescribeApps": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "AppIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "Apps": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AppId": {}, + "StackId": {}, + "Shortname": {}, + "Name": {}, + "Description": {}, + "DataSources": { + "shape": "Sh" + }, + "Type": {}, + "AppSource": { + "shape": "Sb" + }, + "Domains": { + "shape": "Sd" + }, + "EnableSsl": { + "type": "boolean" + }, + "SslConfiguration": { + "shape": "Sk" + }, + "Attributes": { + "shape": "Sl" + }, + "CreatedAt": {}, + "Environment": { + "shape": "Sn" + } + } + } + } + } + } + }, + "DescribeCommands": { + "input": { + "type": "structure", + "members": { + "DeploymentId": {}, + "InstanceId": {}, + "CommandIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "Commands": { + "type": "list", + "member": { + "type": "structure", + "members": { + "CommandId": {}, + "InstanceId": {}, + "DeploymentId": {}, + "CreatedAt": {}, + "AcknowledgedAt": {}, + "CompletedAt": {}, + "Status": {}, + "ExitCode": { + "type": "integer" + }, + "LogUrl": {}, + "Type": {} + } + } + } + } + } + }, + "DescribeDeployments": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "AppId": {}, + "DeploymentIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "Deployments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DeploymentId": {}, + "StackId": {}, + "AppId": {}, + "CreatedAt": {}, + "CompletedAt": {}, + "Duration": { + "type": "integer" + }, + "IamUserArn": {}, + "Comment": {}, + "Command": { + "shape": "Sr" + }, + "Status": {}, + "CustomJson": {}, + "InstanceIds": { + "shape": "Sd" + } + } + } + } + } + } + }, + "DescribeElasticIps": { + "input": { + "type": "structure", + "members": { + "InstanceId": {}, + "StackId": {}, + "Ips": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "ElasticIps": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Ip": {}, + "Name": {}, + "Domain": {}, + "Region": {}, + "InstanceId": {} + } + } + } + } + } + }, + "DescribeElasticLoadBalancers": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "LayerIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "ElasticLoadBalancers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ElasticLoadBalancerName": {}, + "Region": {}, + "DnsName": {}, + "StackId": {}, + "LayerId": {}, + "VpcId": {}, + "AvailabilityZones": { + "shape": "Sd" + }, + "SubnetIds": { + "shape": "Sd" + }, + "Ec2InstanceIds": { + "shape": "Sd" + } + } + } + } + } + } + }, + "DescribeInstances": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "LayerId": {}, + "InstanceIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "Instances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {}, + "Ec2InstanceId": {}, + "VirtualizationType": {}, + "Hostname": {}, + "StackId": {}, + "LayerIds": { + "shape": "Sd" + }, + "SecurityGroupIds": { + "shape": "Sd" + }, + "InstanceType": {}, + "InstanceProfileArn": {}, + "Status": {}, + "Os": {}, + "AmiId": {}, + "AvailabilityZone": {}, + "SubnetId": {}, + "PublicDns": {}, + "PrivateDns": {}, + "PublicIp": {}, + "PrivateIp": {}, + "ElasticIp": {}, + "AutoScalingType": {}, + "SshKeyName": {}, + "SshHostRsaKeyFingerprint": {}, + "SshHostDsaKeyFingerprint": {}, + "CreatedAt": {}, + "LastServiceErrorId": {}, + "Architecture": {}, + "RootDeviceType": {}, + "RootDeviceVolumeId": {}, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "EbsOptimized": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribeLayers": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "LayerIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "Layers": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StackId": {}, + "LayerId": {}, + "Type": {}, + "Name": {}, + "Shortname": {}, + "Attributes": { + "shape": "S11" + }, + "CustomInstanceProfileArn": {}, + "CustomSecurityGroupIds": { + "shape": "Sd" + }, + "DefaultSecurityGroupNames": { + "shape": "Sd" + }, + "Packages": { + "shape": "Sd" + }, + "VolumeConfigurations": { + "shape": "S13" + }, + "EnableAutoHealing": { + "type": "boolean" + }, + "AutoAssignElasticIps": { + "type": "boolean" + }, + "AutoAssignPublicIps": { + "type": "boolean" + }, + "DefaultRecipes": { + "shape": "S16" + }, + "CustomRecipes": { + "shape": "S16" + }, + "CreatedAt": {}, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "UseEbsOptimizedInstances": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribeLoadBasedAutoScaling": { + "input": { + "type": "structure", + "required": [ + "LayerIds" + ], + "members": { + "LayerIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "LoadBasedAutoScalingConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "LayerId": {}, + "Enable": { + "type": "boolean" + }, + "UpScaling": { + "shape": "S2i" + }, + "DownScaling": { + "shape": "S2i" + } + } + } + } + } + } + }, + "DescribeMyUserProfile": { + "output": { + "type": "structure", + "members": { + "UserProfile": { + "type": "structure", + "members": { + "IamUserArn": {}, + "Name": {}, + "SshUsername": {}, + "SshPublicKey": {} + } + } + } + } + }, + "DescribePermissions": { + "input": { + "type": "structure", + "members": { + "IamUserArn": {}, + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Permissions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StackId": {}, + "IamUserArn": {}, + "AllowSsh": { + "type": "boolean" + }, + "AllowSudo": { + "type": "boolean" + }, + "Level": {} + } + } + } + } + } + }, + "DescribeRaidArrays": { + "input": { + "type": "structure", + "members": { + "InstanceId": {}, + "StackId": {}, + "RaidArrayIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "RaidArrays": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RaidArrayId": {}, + "InstanceId": {}, + "Name": {}, + "RaidLevel": { + "type": "integer" + }, + "NumberOfDisks": { + "type": "integer" + }, + "Size": { + "type": "integer" + }, + "Device": {}, + "MountPoint": {}, + "AvailabilityZone": {}, + "CreatedAt": {}, + "StackId": {}, + "VolumeType": {}, + "Iops": { + "type": "integer" + } + } + } + } + } + } + }, + "DescribeRdsDbInstances": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {}, + "RdsDbInstanceArns": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "RdsDbInstances": { + "type": "list", + "member": { + "type": "structure", + "members": { + "RdsDbInstanceArn": {}, + "DbInstanceIdentifier": {}, + "DbUser": {}, + "DbPassword": {}, + "Region": {}, + "Address": {}, + "Engine": {}, + "StackId": {}, + "MissingOnRds": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribeServiceErrors": { + "input": { + "type": "structure", + "members": { + "StackId": {}, + "InstanceId": {}, + "ServiceErrorIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "ServiceErrors": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ServiceErrorId": {}, + "StackId": {}, + "InstanceId": {}, + "Type": {}, + "Message": {}, + "CreatedAt": {} + } + } + } + } + } + }, + "DescribeStackSummary": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "StackSummary": { + "type": "structure", + "members": { + "StackId": {}, + "Name": {}, + "Arn": {}, + "LayersCount": { + "type": "integer" + }, + "AppsCount": { + "type": "integer" + }, + "InstancesCount": { + "type": "structure", + "members": { + "Booting": { + "type": "integer" + }, + "ConnectionLost": { + "type": "integer" + }, + "Online": { + "type": "integer" + }, + "Pending": { + "type": "integer" + }, + "Rebooting": { + "type": "integer" + }, + "Requested": { + "type": "integer" + }, + "RunningSetup": { + "type": "integer" + }, + "SetupFailed": { + "type": "integer" + }, + "ShuttingDown": { + "type": "integer" + }, + "StartFailed": { + "type": "integer" + }, + "Stopped": { + "type": "integer" + }, + "Stopping": { + "type": "integer" + }, + "Terminated": { + "type": "integer" + }, + "Terminating": { + "type": "integer" + } + } + } + } + } + } + } + }, + "DescribeStacks": { + "input": { + "type": "structure", + "members": { + "StackIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "Stacks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "StackId": {}, + "Name": {}, + "Arn": {}, + "Region": {}, + "VpcId": {}, + "Attributes": { + "shape": "S6" + }, + "ServiceRoleArn": {}, + "DefaultInstanceProfileArn": {}, + "DefaultOs": {}, + "HostnameTheme": {}, + "DefaultAvailabilityZone": {}, + "DefaultSubnetId": {}, + "CustomJson": {}, + "ConfigurationManager": { + "shape": "S8" + }, + "ChefConfiguration": { + "shape": "S9" + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "UseOpsworksSecurityGroups": { + "type": "boolean" + }, + "CustomCookbooksSource": { + "shape": "Sb" + }, + "DefaultSshKeyName": {}, + "CreatedAt": {}, + "DefaultRootDeviceType": {} + } + } + } + } + } + }, + "DescribeTimeBasedAutoScaling": { + "input": { + "type": "structure", + "required": [ + "InstanceIds" + ], + "members": { + "InstanceIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "TimeBasedAutoScalingConfigurations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceId": {}, + "AutoScalingSchedule": { + "shape": "S3f" + } + } + } + } + } + } + }, + "DescribeUserProfiles": { + "input": { + "type": "structure", + "members": { + "IamUserArns": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "UserProfiles": { + "type": "list", + "member": { + "type": "structure", + "members": { + "IamUserArn": {}, + "Name": {}, + "SshUsername": {}, + "SshPublicKey": {}, + "AllowSelfManagement": { + "type": "boolean" + } + } + } + } + } + } + }, + "DescribeVolumes": { + "input": { + "type": "structure", + "members": { + "InstanceId": {}, + "StackId": {}, + "RaidArrayId": {}, + "VolumeIds": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "members": { + "Volumes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeId": {}, + "Ec2VolumeId": {}, + "Name": {}, + "RaidArrayId": {}, + "InstanceId": {}, + "Status": {}, + "Size": { + "type": "integer" + }, + "Device": {}, + "MountPoint": {}, + "Region": {}, + "AvailabilityZone": {}, + "VolumeType": {}, + "Iops": { + "type": "integer" + } + } + } + } + } + } + }, + "DetachElasticLoadBalancer": { + "input": { + "type": "structure", + "required": [ + "ElasticLoadBalancerName", + "LayerId" + ], + "members": { + "ElasticLoadBalancerName": {}, + "LayerId": {} + } + } + }, + "DisassociateElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp" + ], + "members": { + "ElasticIp": {} + } + } + }, + "GetHostnameSuggestion": { + "input": { + "type": "structure", + "required": [ + "LayerId" + ], + "members": { + "LayerId": {} + } + }, + "output": { + "type": "structure", + "members": { + "LayerId": {}, + "Hostname": {} + } + } + }, + "RebootInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {} + } + } + }, + "RegisterElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp", + "StackId" + ], + "members": { + "ElasticIp": {}, + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ElasticIp": {} + } + } + }, + "RegisterRdsDbInstance": { + "input": { + "type": "structure", + "required": [ + "StackId", + "RdsDbInstanceArn", + "DbUser", + "DbPassword" + ], + "members": { + "StackId": {}, + "RdsDbInstanceArn": {}, + "DbUser": {}, + "DbPassword": {} + } + } + }, + "RegisterVolume": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "Ec2VolumeId": {}, + "StackId": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeId": {} + } + } + }, + "SetLoadBasedAutoScaling": { + "input": { + "type": "structure", + "required": [ + "LayerId" + ], + "members": { + "LayerId": {}, + "Enable": { + "type": "boolean" + }, + "UpScaling": { + "shape": "S2i" + }, + "DownScaling": { + "shape": "S2i" + } + } + } + }, + "SetPermission": { + "input": { + "type": "structure", + "required": [ + "StackId", + "IamUserArn" + ], + "members": { + "StackId": {}, + "IamUserArn": {}, + "AllowSsh": { + "type": "boolean" + }, + "AllowSudo": { + "type": "boolean" + }, + "Level": {} + } + } + }, + "SetTimeBasedAutoScaling": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "AutoScalingSchedule": { + "shape": "S3f" + } + } + } + }, + "StartInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {} + } + } + }, + "StartStack": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + } + }, + "StopInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {} + } + } + }, + "StopStack": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {} + } + } + }, + "UnassignVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {} + } + } + }, + "UpdateApp": { + "input": { + "type": "structure", + "required": [ + "AppId" + ], + "members": { + "AppId": {}, + "Name": {}, + "Description": {}, + "DataSources": { + "shape": "Sh" + }, + "Type": {}, + "AppSource": { + "shape": "Sb" + }, + "Domains": { + "shape": "Sd" + }, + "EnableSsl": { + "type": "boolean" + }, + "SslConfiguration": { + "shape": "Sk" + }, + "Attributes": { + "shape": "Sl" + }, + "Environment": { + "shape": "Sn" + } + } + } + }, + "UpdateElasticIp": { + "input": { + "type": "structure", + "required": [ + "ElasticIp" + ], + "members": { + "ElasticIp": {}, + "Name": {} + } + } + }, + "UpdateInstance": { + "input": { + "type": "structure", + "required": [ + "InstanceId" + ], + "members": { + "InstanceId": {}, + "LayerIds": { + "shape": "Sd" + }, + "InstanceType": {}, + "AutoScalingType": {}, + "Hostname": {}, + "Os": {}, + "AmiId": {}, + "SshKeyName": {}, + "Architecture": {}, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "EbsOptimized": { + "type": "boolean" + } + } + } + }, + "UpdateLayer": { + "input": { + "type": "structure", + "required": [ + "LayerId" + ], + "members": { + "LayerId": {}, + "Name": {}, + "Shortname": {}, + "Attributes": { + "shape": "S11" + }, + "CustomInstanceProfileArn": {}, + "CustomSecurityGroupIds": { + "shape": "Sd" + }, + "Packages": { + "shape": "Sd" + }, + "VolumeConfigurations": { + "shape": "S13" + }, + "EnableAutoHealing": { + "type": "boolean" + }, + "AutoAssignElasticIps": { + "type": "boolean" + }, + "AutoAssignPublicIps": { + "type": "boolean" + }, + "CustomRecipes": { + "shape": "S16" + }, + "InstallUpdatesOnBoot": { + "type": "boolean" + }, + "UseEbsOptimizedInstances": { + "type": "boolean" + } + } + } + }, + "UpdateMyUserProfile": { + "input": { + "type": "structure", + "members": { + "SshPublicKey": {} + } + } + }, + "UpdateRdsDbInstance": { + "input": { + "type": "structure", + "required": [ + "RdsDbInstanceArn" + ], + "members": { + "RdsDbInstanceArn": {}, + "DbUser": {}, + "DbPassword": {} + } + } + }, + "UpdateStack": { + "input": { + "type": "structure", + "required": [ + "StackId" + ], + "members": { + "StackId": {}, + "Name": {}, + "Attributes": { + "shape": "S6" + }, + "ServiceRoleArn": {}, + "DefaultInstanceProfileArn": {}, + "DefaultOs": {}, + "HostnameTheme": {}, + "DefaultAvailabilityZone": {}, + "DefaultSubnetId": {}, + "CustomJson": {}, + "ConfigurationManager": { + "shape": "S8" + }, + "ChefConfiguration": { + "shape": "S9" + }, + "UseCustomCookbooks": { + "type": "boolean" + }, + "CustomCookbooksSource": { + "shape": "Sb" + }, + "DefaultSshKeyName": {}, + "DefaultRootDeviceType": {}, + "UseOpsworksSecurityGroups": { + "type": "boolean" + } + } + } + }, + "UpdateUserProfile": { + "input": { + "type": "structure", + "required": [ + "IamUserArn" + ], + "members": { + "IamUserArn": {}, + "SshUsername": {}, + "SshPublicKey": {}, + "AllowSelfManagement": { + "type": "boolean" + } + } + } + }, + "UpdateVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeId" + ], + "members": { + "VolumeId": {}, + "Name": {}, + "MountPoint": {} + } + } + } + }, + "shapes": { + "S6": { + "type": "map", + "key": {}, + "value": {} + }, + "S8": { + "type": "structure", + "members": { + "Name": {}, + "Version": {} + } + }, + "S9": { + "type": "structure", + "members": { + "ManageBerkshelf": { + "type": "boolean" + }, + "BerkshelfVersion": {} + } + }, + "Sb": { + "type": "structure", + "members": { + "Type": {}, + "Url": {}, + "Username": {}, + "Password": {}, + "SshKey": {}, + "Revision": {} + } + }, + "Sd": { + "type": "list", + "member": {} + }, + "Sh": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Type": {}, + "Arn": {}, + "DatabaseName": {} + } + } + }, + "Sk": { + "type": "structure", + "required": [ + "Certificate", + "PrivateKey" + ], + "members": { + "Certificate": {}, + "PrivateKey": {}, + "Chain": {} + } + }, + "Sl": { + "type": "map", + "key": {}, + "value": {} + }, + "Sn": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {}, + "Secure": { + "type": "boolean" + } + } + } + }, + "Sr": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Args": { + "type": "map", + "key": {}, + "value": { + "shape": "Sd" + } + } + } + }, + "S11": { + "type": "map", + "key": {}, + "value": {} + }, + "S13": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "MountPoint", + "NumberOfDisks", + "Size" + ], + "members": { + "MountPoint": {}, + "RaidLevel": { + "type": "integer" + }, + "NumberOfDisks": { + "type": "integer" + }, + "Size": { + "type": "integer" + }, + "VolumeType": {}, + "Iops": { + "type": "integer" + } + } + } + }, + "S16": { + "type": "structure", + "members": { + "Setup": { + "shape": "Sd" + }, + "Configure": { + "shape": "Sd" + }, + "Deploy": { + "shape": "Sd" + }, + "Undeploy": { + "shape": "Sd" + }, + "Shutdown": { + "shape": "Sd" + } + } + }, + "S2i": { + "type": "structure", + "members": { + "InstanceCount": { + "type": "integer" + }, + "ThresholdsWaitTime": { + "type": "integer" + }, + "IgnoreMetricsTime": { + "type": "integer" + }, + "CpuThreshold": { + "type": "double" + }, + "MemoryThreshold": { + "type": "double" + }, + "LoadThreshold": { + "type": "double" + } + } + }, + "S3f": { + "type": "structure", + "members": { + "Monday": { + "shape": "S3g" + }, + "Tuesday": { + "shape": "S3g" + }, + "Wednesday": { + "shape": "S3g" + }, + "Thursday": { + "shape": "S3g" + }, + "Friday": { + "shape": "S3g" + }, + "Saturday": { + "shape": "S3g" + }, + "Sunday": { + "shape": "S3g" + } + } + }, + "S3g": { + "type": "map", + "key": {}, + "value": {} + } + } +} \ No newline at end of file diff --git a/apis/opsworks-2013-02-18.full.json b/apis/opsworks-2013-02-18.full.json new file mode 100644 index 0000000000..d7d7824fbc --- /dev/null +++ b/apis/opsworks-2013-02-18.full.json @@ -0,0 +1,4404 @@ +{ + "metadata":{ + "apiVersion":"2013-02-18", + "endpointPrefix":"opsworks", + "jsonVersion":"1.1", + "serviceFullName":"AWS OpsWorks", + "signatureVersion":"v4", + "targetPrefix":"OpsWorks_20130218", + "protocol":"json" + }, + "documentation":"AWS OpsWorks

Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.

AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.10. For more information, see Chef Versions.

", + "operations":{ + "AssignVolume":{ + "name":"AssignVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignVolumeRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "AssociateElasticIp":{ + "name":"AssociateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateElasticIpRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "AttachElasticLoadBalancer":{ + "name":"AttachElasticLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachElasticLoadBalancerRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CloneStack":{ + "name":"CloneStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CloneStackRequest"}, + "output":{ + "shape":"CloneStackResult", + "documentation":"

Contains the response to a CloneStack request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Creates a clone of a specified stack. For more information, see Clone a Stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateApp":{ + "name":"CreateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAppRequest"}, + "output":{ + "shape":"CreateAppResult", + "documentation":"

Contains the response to a CreateApp request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Creates an app for a specified stack. For more information, see Creating Apps.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateDeployment":{ + "name":"CreateDeployment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDeploymentRequest"}, + "output":{ + "shape":"CreateDeploymentResult", + "documentation":"

Contains the response to a CreateDeployment request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deploys a stack or app.

For more information, see Deploying Apps and Run Stack Commands.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateInstance":{ + "name":"CreateInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceRequest"}, + "output":{ + "shape":"CreateInstanceResult", + "documentation":"

Contains the response to a CreateInstance request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateLayer":{ + "name":"CreateLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLayerRequest"}, + "output":{ + "shape":"CreateLayerResult", + "documentation":"

Contains the response to a CreateLayer request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Creates a layer. For more information, see How to Create a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateStack":{ + "name":"CreateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStackRequest"}, + "output":{ + "shape":"CreateStackResult", + "documentation":"

Contains the response to a CreateStack request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + } + ], + "documentation":"

Creates a new stack. For more information, see Create a New Stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateUserProfile":{ + "name":"CreateUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserProfileRequest"}, + "output":{ + "shape":"CreateUserProfileResult", + "documentation":"

Contains the response to a CreateUserProfile request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + } + ], + "documentation":"

Creates a new user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteApp":{ + "name":"DeleteApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAppRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deletes a specified app.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteInstance":{ + "name":"DeleteInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInstanceRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deletes a specified instance. You must stop an instance before you can delete it. For more information, see Deleting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteLayer":{ + "name":"DeleteLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLayerRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deletes a specified layer. You must first stop and then delete all associated instances. For more information, see How to Delete a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteStack":{ + "name":"DeleteStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStackRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deletes a specified stack. You must first delete all instances, layers, and apps. For more information, see Shut Down a Stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteUserProfile":{ + "name":"DeleteUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserProfileRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deletes a user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeregisterElasticIp":{ + "name":"DeregisterElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterElasticIpRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeregisterRdsDbInstance":{ + "name":"DeregisterRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterRdsDbInstanceRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deregisters an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeregisterVolume":{ + "name":"DeregisterVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterVolumeRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeApps":{ + "name":"DescribeApps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAppsRequest"}, + "output":{ + "shape":"DescribeAppsResult", + "documentation":"

Contains the response to a DescribeApps request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Requests a description of a specified set of apps.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeCommands":{ + "name":"DescribeCommands", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCommandsRequest"}, + "output":{ + "shape":"DescribeCommandsResult", + "documentation":"

Contains the response to a DescribeCommands request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes the results of specified commands.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeDeployments":{ + "name":"DescribeDeployments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDeploymentsRequest"}, + "output":{ + "shape":"DescribeDeploymentsResult", + "documentation":"

Contains the response to a DescribeDeployments request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Requests a description of a specified set of deployments.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeElasticIps":{ + "name":"DescribeElasticIps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeElasticIpsRequest"}, + "output":{ + "shape":"DescribeElasticIpsResult", + "documentation":"

Contains the response to a DescribeElasticIps request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes Elastic IP addresses.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeElasticLoadBalancers":{ + "name":"DescribeElasticLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeElasticLoadBalancersRequest"}, + "output":{ + "shape":"DescribeElasticLoadBalancersResult", + "documentation":"

Contains the response to a DescribeElasticLoadBalancers request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes a stack's Elastic Load Balancing instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{ + "shape":"DescribeInstancesResult", + "documentation":"

Contains the response to a DescribeInstances request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Requests a description of a set of instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeLayers":{ + "name":"DescribeLayers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLayersRequest"}, + "output":{ + "shape":"DescribeLayersResult", + "documentation":"

Contains the response to a DescribeLayers request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Requests a description of one or more layers in a specified stack.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeLoadBasedAutoScaling":{ + "name":"DescribeLoadBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBasedAutoScalingRequest"}, + "output":{ + "shape":"DescribeLoadBasedAutoScalingResult", + "documentation":"

Contains the response to a DescribeLoadBasedAutoScaling request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes load-based auto scaling configurations for specified layers.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeMyUserProfile":{ + "name":"DescribeMyUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeMyUserProfileResult", + "documentation":"

Contains the response to a DescribeMyUserProfile request.

" + }, + "documentation":"

Describes a user's SSH information.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribePermissions":{ + "name":"DescribePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePermissionsRequest"}, + "output":{ + "shape":"DescribePermissionsResult", + "documentation":"

Contains the response to a DescribePermissions request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes the permissions for a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeRaidArrays":{ + "name":"DescribeRaidArrays", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRaidArraysRequest"}, + "output":{ + "shape":"DescribeRaidArraysResult", + "documentation":"

Contains the response to a DescribeRaidArrays request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describe an instance's RAID arrays.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeRdsDbInstances":{ + "name":"DescribeRdsDbInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRdsDbInstancesRequest"}, + "output":{ + "shape":"DescribeRdsDbInstancesResult", + "documentation":"

Contains the response to a DescribeRdsDbInstances request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes Amazon RDS instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeServiceErrors":{ + "name":"DescribeServiceErrors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceErrorsRequest"}, + "output":{ + "shape":"DescribeServiceErrorsResult", + "documentation":"

Contains the response to a DescribeServiceErrors request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes AWS OpsWorks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeStackSummary":{ + "name":"DescribeStackSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackSummaryRequest"}, + "output":{ + "shape":"DescribeStackSummaryResult", + "documentation":"

Contains the response to a DescribeStackSummary request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeStacks":{ + "name":"DescribeStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStacksRequest"}, + "output":{ + "shape":"DescribeStacksResult", + "documentation":"

Contains the response to a DescribeStacks request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Requests a description of one or more stacks.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeTimeBasedAutoScaling":{ + "name":"DescribeTimeBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTimeBasedAutoScalingRequest"}, + "output":{ + "shape":"DescribeTimeBasedAutoScalingResult", + "documentation":"

Contains the response to a DescribeTimeBasedAutoScaling request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes time-based auto scaling configurations for specified instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeUserProfiles":{ + "name":"DescribeUserProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserProfilesRequest"}, + "output":{ + "shape":"DescribeUserProfilesResult", + "documentation":"

Contains the response to a DescribeUserProfiles request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describe specified users.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{ + "shape":"DescribeVolumesResult", + "documentation":"

Contains the response to a DescribeVolumes request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Describes an instance's Amazon EBS volumes.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DetachElasticLoadBalancer":{ + "name":"DetachElasticLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachElasticLoadBalancerRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Detaches a specified Elastic Load Balancing instance from its layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DisassociateElasticIp":{ + "name":"DisassociateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateElasticIpRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "GetHostnameSuggestion":{ + "name":"GetHostnameSuggestion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetHostnameSuggestionRequest"}, + "output":{ + "shape":"GetHostnameSuggestionResult", + "documentation":"

Contains the response to a GetHostnameSuggestion request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Gets a generated host name for the specified layer, based on the current host name theme.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RebootInstance":{ + "name":"RebootInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstanceRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RegisterElasticIp":{ + "name":"RegisterElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterElasticIpRequest"}, + "output":{ + "shape":"RegisterElasticIpResult", + "documentation":"

Contains the response to a RegisterElasticIp request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RegisterRdsDbInstance":{ + "name":"RegisterRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterRdsDbInstanceRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Registers an Amazon RDS instance with a stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RegisterVolume":{ + "name":"RegisterVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterVolumeRequest"}, + "output":{ + "shape":"RegisterVolumeResult", + "documentation":"

Contains the response to a RegisterVolume request.

" + }, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "SetLoadBasedAutoScaling":{ + "name":"SetLoadBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLoadBasedAutoScalingRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "SetPermission":{ + "name":"SetPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetPermissionRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Specifies a user's permissions. For more information, see Security and Permissions.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "SetTimeBasedAutoScaling":{ + "name":"SetTimeBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetTimeBasedAutoScalingRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "StartInstance":{ + "name":"StartInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstanceRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "StartStack":{ + "name":"StartStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartStackRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Starts a stack's instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "StopInstance":{ + "name":"StopInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstanceRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "StopStack":{ + "name":"StopStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopStackRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Stops a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UnassignVolume":{ + "name":"UnassignVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignVolumeRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateApp":{ + "name":"UpdateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAppRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Updates a specified app.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateElasticIp":{ + "name":"UpdateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateElasticIpRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Updates a registered Elastic IP address's name. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateInstance":{ + "name":"UpdateInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateInstanceRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Updates a specified instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateLayer":{ + "name":"UpdateLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLayerRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Updates a specified layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateMyUserProfile":{ + "name":"UpdateMyUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMyUserProfileRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + } + ], + "documentation":"

Updates a user's SSH public key.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateRdsDbInstance":{ + "name":"UpdateRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRdsDbInstanceRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Updates an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateStack":{ + "name":"UpdateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStackRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Updates a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateUserProfile":{ + "name":"UpdateUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserProfileRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Updates a specified user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateVolume":{ + "name":"UpdateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVolumeRequest"}, + "errors":[ + { + "shape":"ValidationException", + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + } + ], + "documentation":"

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + } + }, + "shapes":{ + "App":{ + "type":"structure", + "members":{ + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The app stack ID.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

The app's short name.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The app name.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the app.

" + }, + "DataSources":{ + "shape":"DataSources", + "documentation":"

The app's data sources.

" + }, + "Type":{ + "shape":"AppType", + "documentation":"

The app type.

" + }, + "AppSource":{ + "shape":"Source", + "documentation":"

A Source object that describes the app repository.

" + }, + "Domains":{ + "shape":"Strings", + "documentation":"

The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

" + }, + "EnableSsl":{ + "shape":"Boolean", + "documentation":"

Whether to enable SSL for the app.

" + }, + "SslConfiguration":{ + "shape":"SslConfiguration", + "documentation":"

An SslConfiguration object with the SSL configuration.

" + }, + "Attributes":{ + "shape":"AppAttributes", + "documentation":"

The stack attributes.

" + }, + "CreatedAt":{ + "shape":"String", + "documentation":"

When the app was created.

" + }, + "Environment":{ + "shape":"EnvironmentVariables", + "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instances.

" + } + }, + "documentation":"

A description of the app.

" + }, + "AppAttributes":{ + "type":"map", + "key":{"shape":"AppAttributesKeys"}, + "value":{"shape":"String"} + }, + "AppAttributesKeys":{ + "type":"string", + "enum":[ + "DocumentRoot", + "RailsEnv", + "AutoBundleOnDeploy" + ] + }, + "AppType":{ + "type":"string", + "enum":[ + "java", + "rails", + "php", + "nodejs", + "static", + "other" + ] + }, + "Apps":{ + "type":"list", + "member":{"shape":"App"} + }, + "Architecture":{ + "type":"string", + "enum":[ + "x86_64", + "i386" + ] + }, + "AssignVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "AssociateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "AttachElasticLoadBalancerRequest":{ + "type":"structure", + "required":[ + "ElasticLoadBalancerName", + "LayerId" + ], + "members":{ + "ElasticLoadBalancerName":{ + "shape":"String", + "documentation":"

The Elastic Load Balancing instance's name.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

The ID of the layer that the Elastic Load Balancing instance is to be attached to.

" + } + } + }, + "AutoScalingThresholds":{ + "type":"structure", + "members":{ + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances to add or remove when the load exceeds a threshold.

" + }, + "ThresholdsWaitTime":{ + "shape":"Minute", + "documentation":"

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

" + }, + "IgnoreMetricsTime":{ + "shape":"Minute", + "documentation":"

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and not raise any additional scaling events. For example, AWS OpsWorks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough to get the new instances online.

" + }, + "CpuThreshold":{ + "shape":"Double", + "documentation":"

The CPU utilization threshold, as a percent of the available CPU.

" + }, + "MemoryThreshold":{ + "shape":"Double", + "documentation":"

The memory utilization threshold, as a percent of the available memory.

" + }, + "LoadThreshold":{ + "shape":"Double", + "documentation":"

The load threshold. For more information about how load is computed, see Load (computing).

" + } + }, + "documentation":"

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks starts or stops load-based instances.

" + }, + "AutoScalingType":{ + "type":"string", + "enum":[ + "load", + "timer" + ] + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ChefConfiguration":{ + "type":"structure", + "members":{ + "ManageBerkshelf":{ + "shape":"Boolean", + "documentation":"

Whether to enable Berkshelf.

" + }, + "BerkshelfVersion":{ + "shape":"String", + "documentation":"

The Berkshelf version.

" + } + }, + "documentation":"

Describes the Chef configuration.

" + }, + "CloneStackRequest":{ + "type":"structure", + "required":[ + "SourceStackId", + "ServiceRoleArn" + ], + "members":{ + "SourceStackId":{ + "shape":"String", + "documentation":"

The source stack ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The cloned stack name.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The cloned stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.

" + }, + "Attributes":{ + "shape":"StackAttributes", + "documentation":"

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultOs":{ + "shape":"String", + "documentation":"

The cloned stack's default operating system, which must be set to Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. The default option is Amazon Linux.

" + }, + "HostnameTheme":{ + "shape":"String", + "documentation":"

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" + }, + "DefaultAvailabilityZone":{ + "shape":"String", + "documentation":"

The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

" + }, + "DefaultSubnetId":{ + "shape":"String", + "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

" + }, + "ChefConfiguration":{ + "shape":"ChefConfiguration", + "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + }, + "UseCustomCookbooks":{ + "shape":"Boolean", + "documentation":"

Whether to use custom cookbooks.

" + }, + "UseOpsworksSecurityGroups":{ + "shape":"Boolean", + "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

" + }, + "CustomCookbooksSource":{"shape":"Source"}, + "DefaultSshKeyName":{ + "shape":"String", + "documentation":"

A default SSH key for the stack instances. You can override this value when you create or update an instance.

" + }, + "ClonePermissions":{ + "shape":"Boolean", + "documentation":"

Whether to clone the source stack's permissions.

" + }, + "CloneAppIds":{ + "shape":"Strings", + "documentation":"

A list of source stack app IDs to be included in the cloned stack.

" + }, + "DefaultRootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + } + } + }, + "CloneStackResult":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The cloned stack ID.

" + } + }, + "documentation":"

Contains the response to a CloneStack request.

" + }, + "Command":{ + "type":"structure", + "members":{ + "CommandId":{ + "shape":"String", + "documentation":"

The command ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance where the command was executed.

" + }, + "DeploymentId":{ + "shape":"String", + "documentation":"

The command deployment ID.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

Date and time when the command was run.

" + }, + "AcknowledgedAt":{ + "shape":"DateTime", + "documentation":"

Date and time when the command was acknowledged.

" + }, + "CompletedAt":{ + "shape":"DateTime", + "documentation":"

Date when the command completed.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The command status:

" + }, + "ExitCode":{ + "shape":"Integer", + "documentation":"

The command exit code.

" + }, + "LogUrl":{ + "shape":"String", + "documentation":"

The URL of the command log.

" + }, + "Type":{ + "shape":"String", + "documentation":"

The command type:

" + } + }, + "documentation":"

Describes a command.

" + }, + "Commands":{ + "type":"list", + "member":{"shape":"Command"} + }, + "CreateAppRequest":{ + "type":"structure", + "required":[ + "StackId", + "Name", + "Type" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

The app's short name.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The app name.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the app.

" + }, + "DataSources":{ + "shape":"DataSources", + "documentation":"

The app's data source.

" + }, + "Type":{ + "shape":"AppType", + "documentation":"

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks deploys an application to those instances that are members of the corresponding layer.

" + }, + "AppSource":{ + "shape":"Source", + "documentation":"

A Source object that specifies the app repository.

" + }, + "Domains":{ + "shape":"Strings", + "documentation":"

The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

" + }, + "EnableSsl":{ + "shape":"Boolean", + "documentation":"

Whether to enable SSL for the app.

" + }, + "SslConfiguration":{ + "shape":"SslConfiguration", + "documentation":"

An SslConfiguration object with the SSL configuration.

" + }, + "Attributes":{ + "shape":"AppAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "Environment":{ + "shape":"EnvironmentVariables", + "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instance.

" + } + } + }, + "CreateAppResult":{ + "type":"structure", + "members":{ + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + } + }, + "documentation":"

Contains the response to a CreateApp request.

" + }, + "CreateDeploymentRequest":{ + "type":"structure", + "required":[ + "StackId", + "Command" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "AppId":{ + "shape":"String", + "documentation":"

The app ID. This parameter is required for app deployments, but not for other deployment commands.

" + }, + "InstanceIds":{ + "shape":"Strings", + "documentation":"

The instance IDs for the deployment targets.

" + }, + "Command":{ + "shape":"DeploymentCommand", + "documentation":"

A DeploymentCommand object that specifies the deployment command and any associated arguments.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" + } + } + }, + "CreateDeploymentResult":{ + "type":"structure", + "members":{ + "DeploymentId":{ + "shape":"String", + "documentation":"

The deployment ID, which can be used with other requests to identify the deployment.

" + } + }, + "documentation":"

Contains the response to a CreateDeployment request.

" + }, + "CreateInstanceRequest":{ + "type":"structure", + "required":[ + "StackId", + "LayerIds", + "InstanceType" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

An array that contains the instance layer IDs.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

" + }, + "AutoScalingType":{ + "shape":"AutoScalingType", + "documentation":"

The instance auto scaling type, which has three possible values:

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The instance host name.

" + }, + "Os":{ + "shape":"String", + "documentation":"

The instance operating system, which must be set to one of the following.

The default option is Amazon Linux. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

" + }, + "AmiId":{ + "shape":"String", + "documentation":"

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances

" + }, + "SshKeyName":{ + "shape":"String", + "documentation":"

The instance SSH key name.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The instance Availability Zone. For more information, see Regions and Endpoints.

" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The instance's virtualization type, paravirtual or hvm.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.

" + }, + "Architecture":{ + "shape":"Architecture", + "documentation":"

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

" + }, + "RootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The instance root device type. For more information, see Storage for the Root Device.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Whether to create an Amazon EBS-optimized instance.

" + } + } + }, + "CreateInstanceResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + }, + "documentation":"

Contains the response to a CreateInstance request.

" + }, + "CreateLayerRequest":{ + "type":"structure", + "required":[ + "StackId", + "Type", + "Name", + "Shortname" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The layer stack ID.

" + }, + "Type":{ + "shape":"LayerType", + "documentation":"

The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. This parameter must be set to one of the following:

" + }, + "Name":{ + "shape":"String", + "documentation":"

The layer name, which is used by the console.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

The layer short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

" + }, + "Attributes":{ + "shape":"LayerAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "CustomInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "CustomSecurityGroupIds":{ + "shape":"Strings", + "documentation":"

An array containing the layer custom security group IDs.

" + }, + "Packages":{ + "shape":"Strings", + "documentation":"

An array of Package objects that describe the layer packages.

" + }, + "VolumeConfigurations":{ + "shape":"VolumeConfigurations", + "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + }, + "EnableAutoHealing":{ + "shape":"Boolean", + "documentation":"

Whether to disable auto healing for the layer.

" + }, + "AutoAssignElasticIps":{ + "shape":"Boolean", + "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "AutoAssignPublicIps":{ + "shape":"Boolean", + "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "CustomRecipes":{ + "shape":"Recipes", + "documentation":"

A LayerCustomRecipes object that specifies the layer custom recipes.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

" + }, + "UseEbsOptimizedInstances":{ + "shape":"Boolean", + "documentation":"

Whether to use Amazon EBS-optimized instances.

" + } + } + }, + "CreateLayerResult":{ + "type":"structure", + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + } + }, + "documentation":"

Contains the response to a CreateLayer request.

" + }, + "CreateStackRequest":{ + "type":"structure", + "required":[ + "Name", + "Region", + "ServiceRoleArn", + "DefaultInstanceProfileArn" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The stack name.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The stack AWS region, such as \"us-east-1\". For more information about Amazon regions, see Regions and Endpoints.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC that the stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.

" + }, + "Attributes":{ + "shape":"StackAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultOs":{ + "shape":"String", + "documentation":"

The stack's default operating system, which must be set to Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. The default option is Amazon Linux.

" + }, + "HostnameTheme":{ + "shape":"String", + "documentation":"

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" + }, + "DefaultAvailabilityZone":{ + "shape":"String", + "documentation":"

The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

" + }, + "DefaultSubnetId":{ + "shape":"String", + "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

" + }, + "ChefConfiguration":{ + "shape":"ChefConfiguration", + "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + }, + "UseCustomCookbooks":{ + "shape":"Boolean", + "documentation":"

Whether the stack uses custom cookbooks.

" + }, + "UseOpsworksSecurityGroups":{ + "shape":"Boolean", + "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

" + }, + "CustomCookbooksSource":{"shape":"Source"}, + "DefaultSshKeyName":{ + "shape":"String", + "documentation":"

A default SSH key for the stack instances. You can override this value when you create or update an instance.

" + }, + "DefaultRootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.

" + } + } + }, + "CreateStackResult":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.

" + } + }, + "documentation":"

Contains the response to a CreateStack request.

" + }, + "CreateUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + }, + "SshUsername":{ + "shape":"String", + "documentation":"

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.

" + }, + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's public SSH key.

" + }, + "AllowSelfManagement":{ + "shape":"Boolean", + "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.

" + } + } + }, + "CreateUserProfileResult":{ + "type":"structure", + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + } + }, + "documentation":"

Contains the response to a CreateUserProfile request.

" + }, + "DailyAutoScalingSchedule":{ + "type":"map", + "key":{"shape":"Hour"}, + "value":{"shape":"Switch"} + }, + "DataSource":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The data source's ARN.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

The database name.

" + } + }, + "documentation":"

Describes an app's data source.

" + }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DateTime":{"type":"string"}, + "DeleteAppRequest":{ + "type":"structure", + "required":["AppId"], + "members":{ + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + } + } + }, + "DeleteInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "DeleteElasticIp":{ + "shape":"Boolean", + "documentation":"

Whether to delete the instance Elastic IP address.

" + }, + "DeleteVolumes":{ + "shape":"Boolean", + "documentation":"

Whether to delete the instance's Amazon EBS volumes.

" + } + } + }, + "DeleteLayerRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + } + } + }, + "DeleteStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "DeleteUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + } + } + }, + "Deployment":{ + "type":"structure", + "members":{ + "DeploymentId":{ + "shape":"String", + "documentation":"

The deployment ID.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

Date when the deployment was created.

" + }, + "CompletedAt":{ + "shape":"DateTime", + "documentation":"

Date when the deployment completed.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The deployment duration.

" + }, + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment.

" + }, + "Command":{"shape":"DeploymentCommand"}, + "Status":{ + "shape":"String", + "documentation":"

The deployment status:

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined custom JSON. It is used to override the corresponding default stack configuration JSON values for stack. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" + }, + "InstanceIds":{ + "shape":"Strings", + "documentation":"

The IDs of the target instances.

" + } + }, + "documentation":"

Describes a deployment of a stack or app.

" + }, + "DeploymentCommand":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DeploymentCommandName", + "documentation":"

Specifies the operation. You can specify only one command.

For stacks, the following commands are available:

For apps, the following commands are available:

" + }, + "Args":{ + "shape":"DeploymentCommandArgs", + "documentation":"

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

{\"arg_name\":[\"value1\", \"value2\", ...]}

" + } + }, + "documentation":"

Used to specify a deployment operation.

" + }, + "DeploymentCommandArgs":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Strings"} + }, + "DeploymentCommandName":{ + "type":"string", + "enum":[ + "install_dependencies", + "update_dependencies", + "update_custom_cookbooks", + "execute_recipes", + "deploy", + "rollback", + "start", + "stop", + "restart", + "undeploy" + ] + }, + "Deployments":{ + "type":"list", + "member":{"shape":"Deployment"} + }, + "DeregisterElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + } + } + }, + "DeregisterRdsDbInstanceRequest":{ + "type":"structure", + "required":["RdsDbInstanceArn"], + "members":{ + "RdsDbInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon RDS instance's ARN.

" + } + } + }, + "DeregisterVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + } + } + }, + "DescribeAppsRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

" + }, + "AppIds":{ + "shape":"Strings", + "documentation":"

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

" + } + } + }, + "DescribeAppsResult":{ + "type":"structure", + "members":{ + "Apps":{ + "shape":"Apps", + "documentation":"

An array of App objects that describe the specified apps.

" + } + }, + "documentation":"

Contains the response to a DescribeApps request.

" + }, + "DescribeCommandsRequest":{ + "type":"structure", + "members":{ + "DeploymentId":{ + "shape":"String", + "documentation":"

The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

" + }, + "CommandIds":{ + "shape":"Strings", + "documentation":"

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

" + } + } + }, + "DescribeCommandsResult":{ + "type":"structure", + "members":{ + "Commands":{ + "shape":"Commands", + "documentation":"

An array of Command objects that describe each of the specified commands.

" + } + }, + "documentation":"

Contains the response to a DescribeCommands request.

" + }, + "DescribeDeploymentsRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

" + }, + "AppId":{ + "shape":"String", + "documentation":"

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

" + }, + "DeploymentIds":{ + "shape":"Strings", + "documentation":"

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

" + } + } + }, + "DescribeDeploymentsResult":{ + "type":"structure", + "members":{ + "Deployments":{ + "shape":"Deployments", + "documentation":"

An array of Deployment objects that describe the deployments.

" + } + }, + "documentation":"

Contains the response to a DescribeDeployments request.

" + }, + "DescribeElasticIpsRequest":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

" + }, + "Ips":{ + "shape":"Strings", + "documentation":"

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

" + } + } + }, + "DescribeElasticIpsResult":{ + "type":"structure", + "members":{ + "ElasticIps":{ + "shape":"ElasticIps", + "documentation":"

An ElasticIps object that describes the specified Elastic IP addresses.

" + } + }, + "documentation":"

Contains the response to a DescribeElasticIps request.

" + }, + "DescribeElasticLoadBalancersRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. The action describes the stack's Elastic Load Balancing instances.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

" + } + } + }, + "DescribeElasticLoadBalancersResult":{ + "type":"structure", + "members":{ + "ElasticLoadBalancers":{ + "shape":"ElasticLoadBalancers", + "documentation":"

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

" + } + }, + "documentation":"

Contains the response to a DescribeElasticLoadBalancers request.

" + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

" + }, + "InstanceIds":{ + "shape":"Strings", + "documentation":"

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

" + } + } + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"Instances", + "documentation":"

An array of Instance objects that describe the instances.

" + } + }, + "documentation":"

Contains the response to a DescribeInstances request.

" + }, + "DescribeLayersRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

" + } + } + }, + "DescribeLayersResult":{ + "type":"structure", + "members":{ + "Layers":{ + "shape":"Layers", + "documentation":"

An array of Layer objects that describe the layers.

" + } + }, + "documentation":"

Contains the response to a DescribeLayers request.

" + }, + "DescribeLoadBasedAutoScalingRequest":{ + "type":"structure", + "required":["LayerIds"], + "members":{ + "LayerIds":{ + "shape":"Strings", + "documentation":"

An array of layer IDs.

" + } + } + }, + "DescribeLoadBasedAutoScalingResult":{ + "type":"structure", + "members":{ + "LoadBasedAutoScalingConfigurations":{ + "shape":"LoadBasedAutoScalingConfigurations", + "documentation":"

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

" + } + }, + "documentation":"

Contains the response to a DescribeLoadBasedAutoScaling request.

" + }, + "DescribeMyUserProfileResult":{ + "type":"structure", + "members":{ + "UserProfile":{ + "shape":"SelfUserProfile", + "documentation":"

A UserProfile object that describes the user's SSH information.

" + } + }, + "documentation":"

Contains the response to a DescribeMyUserProfile request.

" + }, + "DescribePermissionsRequest":{ + "type":"structure", + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "DescribePermissionsResult":{ + "type":"structure", + "members":{ + "Permissions":{ + "shape":"Permissions", + "documentation":"

An array of Permission objects that describe the stack permissions.

" + } + }, + "documentation":"

Contains the response to a DescribePermissions request.

" + }, + "DescribeRaidArraysRequest":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "RaidArrayIds":{ + "shape":"Strings", + "documentation":"

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

" + } + } + }, + "DescribeRaidArraysResult":{ + "type":"structure", + "members":{ + "RaidArrays":{ + "shape":"RaidArrays", + "documentation":"

A RaidArrays object that describes the specified RAID arrays.

" + } + }, + "documentation":"

Contains the response to a DescribeRaidArrays request.

" + }, + "DescribeRdsDbInstancesRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.

" + }, + "RdsDbInstanceArns":{ + "shape":"Strings", + "documentation":"

An array containing the ARNs of the instances to be described.

" + } + } + }, + "DescribeRdsDbInstancesResult":{ + "type":"structure", + "members":{ + "RdsDbInstances":{ + "shape":"RdsDbInstances", + "documentation":"

An a array of RdsDbInstance objects that describe the instances.

" + } + }, + "documentation":"

Contains the response to a DescribeRdsDbInstances request.

" + }, + "DescribeServiceErrorsRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

" + }, + "ServiceErrorIds":{ + "shape":"Strings", + "documentation":"

An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

" + } + } + }, + "DescribeServiceErrorsResult":{ + "type":"structure", + "members":{ + "ServiceErrors":{ + "shape":"ServiceErrors", + "documentation":"

An array of ServiceError objects that describe the specified service errors.

" + } + }, + "documentation":"

Contains the response to a DescribeServiceErrors request.

" + }, + "DescribeStackSummaryRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "DescribeStackSummaryResult":{ + "type":"structure", + "members":{ + "StackSummary":{ + "shape":"StackSummary", + "documentation":"

A StackSummary object that contains the results.

" + } + }, + "documentation":"

Contains the response to a DescribeStackSummary request.

" + }, + "DescribeStacksRequest":{ + "type":"structure", + "members":{ + "StackIds":{ + "shape":"Strings", + "documentation":"

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

" + } + } + }, + "DescribeStacksResult":{ + "type":"structure", + "members":{ + "Stacks":{ + "shape":"Stacks", + "documentation":"

An array of Stack objects that describe the stacks.

" + } + }, + "documentation":"

Contains the response to a DescribeStacks request.

" + }, + "DescribeTimeBasedAutoScalingRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"Strings", + "documentation":"

An array of instance IDs.

" + } + } + }, + "DescribeTimeBasedAutoScalingResult":{ + "type":"structure", + "members":{ + "TimeBasedAutoScalingConfigurations":{ + "shape":"TimeBasedAutoScalingConfigurations", + "documentation":"

An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

" + } + }, + "documentation":"

Contains the response to a DescribeTimeBasedAutoScaling request.

" + }, + "DescribeUserProfilesRequest":{ + "type":"structure", + "members":{ + "IamUserArns":{ + "shape":"Strings", + "documentation":"

An array of IAM user ARNs that identify the users to be described.

" + } + } + }, + "DescribeUserProfilesResult":{ + "type":"structure", + "members":{ + "UserProfiles":{ + "shape":"UserProfiles", + "documentation":"

A Users object that describes the specified users.

" + } + }, + "documentation":"

Contains the response to a DescribeUserProfiles request.

" + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. The action describes the stack's registered Amazon EBS volumes.

" + }, + "RaidArrayId":{ + "shape":"String", + "documentation":"

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

" + }, + "VolumeIds":{ + "shape":"Strings", + "documentation":"

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

" + } + } + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"Volumes", + "documentation":"

An array of volume IDs.

" + } + }, + "documentation":"

Contains the response to a DescribeVolumes request.

" + }, + "DetachElasticLoadBalancerRequest":{ + "type":"structure", + "required":[ + "ElasticLoadBalancerName", + "LayerId" + ], + "members":{ + "ElasticLoadBalancerName":{ + "shape":"String", + "documentation":"

The Elastic Load Balancing instance's name.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

The ID of the layer that the Elastic Load Balancing instance is attached to.

" + } + } + }, + "DisassociateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + } + } + }, + "Double":{ + "type":"double", + "box":true + }, + "ElasticIp":{ + "type":"structure", + "members":{ + "Ip":{ + "shape":"String", + "documentation":"

The IP address.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name.

" + }, + "Domain":{ + "shape":"String", + "documentation":"

The domain.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The AWS region. For more information, see Regions and Endpoints.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that the address is attached to.

" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "ElasticIps":{ + "type":"list", + "member":{"shape":"ElasticIp"} + }, + "ElasticLoadBalancer":{ + "type":"structure", + "members":{ + "ElasticLoadBalancerName":{ + "shape":"String", + "documentation":"

The Elastic Load Balancing instance's name.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The instance's AWS region.

" + }, + "DnsName":{ + "shape":"String", + "documentation":"

The instance's public DNS name.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The ID of the stack that the instance is associated with.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

The ID of the layer that the instance is attached to.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The VPC ID.

" + }, + "AvailabilityZones":{ + "shape":"Strings", + "documentation":"

A list of Availability Zones.

" + }, + "SubnetIds":{ + "shape":"Strings", + "documentation":"

A list of subnet IDs, if the stack is running in a VPC.

" + }, + "Ec2InstanceIds":{ + "shape":"Strings", + "documentation":"

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

" + } + }, + "documentation":"

Describes an Elastic Load Balancing instance.

" + }, + "ElasticLoadBalancers":{ + "type":"list", + "member":{"shape":"ElasticLoadBalancer"} + }, + "EnvironmentVariable":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"String", + "documentation":"

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

" + }, + "Value":{ + "shape":"String", + "documentation":"

(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.

" + }, + "Secure":{ + "shape":"Boolean", + "documentation":"

(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns **Filtered** instead of the actual value. The default value for Secure is false.

" + } + }, + "documentation":"

Represents an app's environment variable.

" + }, + "EnvironmentVariables":{ + "type":"list", + "member":{"shape":"EnvironmentVariable"} + }, + "GetHostnameSuggestionRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + } + } + }, + "GetHostnameSuggestionResult":{ + "type":"structure", + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The generated host name.

" + } + }, + "documentation":"

Contains the response to a GetHostnameSuggestion request.

" + }, + "Hour":{"type":"string"}, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "Ec2InstanceId":{ + "shape":"String", + "documentation":"

The ID of the associated Amazon EC2 instance.

" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The instance's virtualization type, paravirtual or hvm.

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The instance host name.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

An array containing the instance layer IDs.

" + }, + "SecurityGroupIds":{ + "shape":"Strings", + "documentation":"

An array containing the instance security group IDs.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that specify the various types are in the API Name column of the Available Instance Types table.

" + }, + "InstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The instance status:

" + }, + "Os":{ + "shape":"String", + "documentation":"

The instance operating system.

" + }, + "AmiId":{ + "shape":"String", + "documentation":"

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The instance Availability Zone. For more information, see Regions and Endpoints.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The instance's subnet ID, if the stack is running in a VPC.

" + }, + "PublicDns":{ + "shape":"String", + "documentation":"

The instance public DNS name.

" + }, + "PrivateDns":{ + "shape":"String", + "documentation":"

The instance private DNS name.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The instance public IP address.

" + }, + "PrivateIp":{ + "shape":"String", + "documentation":"

The instance private IP address.

" + }, + "ElasticIp":{ + "shape":"String", + "documentation":"

The instance Elastic IP address .

" + }, + "AutoScalingType":{ + "shape":"AutoScalingType", + "documentation":"

The instance's auto scaling type, which has three possible values:

" + }, + "SshKeyName":{ + "shape":"String", + "documentation":"

The instance SSH key name.

" + }, + "SshHostRsaKeyFingerprint":{ + "shape":"String", + "documentation":"

The SSH key's RSA fingerprint.

" + }, + "SshHostDsaKeyFingerprint":{ + "shape":"String", + "documentation":"

The SSH key's DSA fingerprint.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

The time that the instance was created.

" + }, + "LastServiceErrorId":{ + "shape":"String", + "documentation":"

The ID of the last service error. For more information, call DescribeServiceErrors.

" + }, + "Architecture":{ + "shape":"Architecture", + "documentation":"

The instance architecture, \"i386\" or \"x86_64\".

" + }, + "RootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The instance root device type. For more information, see Storage for the Root Device.

" + }, + "RootDeviceVolumeId":{ + "shape":"String", + "documentation":"

The root device volume ID.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Whether this is an Amazon EBS-optimized instance.

" + } + }, + "documentation":"

Describes an instance.

" + }, + "Instances":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstancesCount":{ + "type":"structure", + "members":{ + "Booting":{ + "shape":"Integer", + "documentation":"

The number of instances with booting status.

" + }, + "ConnectionLost":{ + "shape":"Integer", + "documentation":"

The number of instances with connection_lost status.

" + }, + "Online":{ + "shape":"Integer", + "documentation":"

The number of instances with online status.

" + }, + "Pending":{ + "shape":"Integer", + "documentation":"

The number of instances with pending status.

" + }, + "Rebooting":{ + "shape":"Integer", + "documentation":"

The number of instances with rebooting status.

" + }, + "Requested":{ + "shape":"Integer", + "documentation":"

The number of instances with requested status.

" + }, + "RunningSetup":{ + "shape":"Integer", + "documentation":"

The number of instances with running_setup status.

" + }, + "SetupFailed":{ + "shape":"Integer", + "documentation":"

The number of instances with setup_failed status.

" + }, + "ShuttingDown":{ + "shape":"Integer", + "documentation":"

The number of instances with shutting_down status.

" + }, + "StartFailed":{ + "shape":"Integer", + "documentation":"

The number of instances with start_failed status.

" + }, + "Stopped":{ + "shape":"Integer", + "documentation":"

The number of instances with stopped status.

" + }, + "Stopping":{ + "shape":"Integer", + "documentation":"

The number of instances with stopping status.

" + }, + "Terminated":{ + "shape":"Integer", + "documentation":"

The number of instances with terminated status.

" + }, + "Terminating":{ + "shape":"Integer", + "documentation":"

The number of instances with terminating status.

" + } + }, + "documentation":"

Describes how many instances a stack has for each status.

" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "Layer":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The layer stack ID.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Type":{ + "shape":"LayerType", + "documentation":"

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

" + }, + "Name":{ + "shape":"String", + "documentation":"

The layer name.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

The layer short name.

" + }, + "Attributes":{ + "shape":"LayerAttributes", + "documentation":"

The layer attributes.

" + }, + "CustomInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "CustomSecurityGroupIds":{ + "shape":"Strings", + "documentation":"

An array containing the layer's custom security group IDs.

" + }, + "DefaultSecurityGroupNames":{ + "shape":"Strings", + "documentation":"

An array containing the layer's security group names.

" + }, + "Packages":{ + "shape":"Strings", + "documentation":"

An array of Package objects that describe the layer's packages.

" + }, + "VolumeConfigurations":{ + "shape":"VolumeConfigurations", + "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + }, + "EnableAutoHealing":{ + "shape":"Boolean", + "documentation":"

Whether auto healing is disabled for the layer.

" + }, + "AutoAssignElasticIps":{ + "shape":"Boolean", + "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "AutoAssignPublicIps":{ + "shape":"Boolean", + "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "DefaultRecipes":{"shape":"Recipes"}, + "CustomRecipes":{ + "shape":"Recipes", + "documentation":"

A LayerCustomRecipes object that specifies the layer's custom recipes.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

Date when the layer was created.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

" + }, + "UseEbsOptimizedInstances":{ + "shape":"Boolean", + "documentation":"

Whether the layer uses Amazon EBS-optimized instances.

" + } + }, + "documentation":"

Describes a layer.

" + }, + "LayerAttributes":{ + "type":"map", + "key":{"shape":"LayerAttributesKeys"}, + "value":{"shape":"String"} + }, + "LayerAttributesKeys":{ + "type":"string", + "enum":[ + "EnableHaproxyStats", + "HaproxyStatsUrl", + "HaproxyStatsUser", + "HaproxyStatsPassword", + "HaproxyHealthCheckUrl", + "HaproxyHealthCheckMethod", + "MysqlRootPassword", + "MysqlRootPasswordUbiquitous", + "GangliaUrl", + "GangliaUser", + "GangliaPassword", + "MemcachedMemory", + "NodejsVersion", + "RubyVersion", + "RubygemsVersion", + "ManageBundler", + "BundlerVersion", + "RailsStack", + "PassengerVersion", + "Jvm", + "JvmVersion", + "JvmOptions", + "JavaAppServer", + "JavaAppServerVersion" + ] + }, + "LayerType":{ + "type":"string", + "enum":[ + "java-app", + "lb", + "web", + "php-app", + "rails-app", + "nodejs-app", + "memcached", + "db-master", + "monitoring-master", + "custom" + ] + }, + "Layers":{ + "type":"list", + "member":{"shape":"Layer"} + }, + "LoadBasedAutoScalingConfiguration":{ + "type":"structure", + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Enable":{ + "shape":"Boolean", + "documentation":"

Whether load-based auto scaling is enabled for the layer.

" + }, + "UpScaling":{ + "shape":"AutoScalingThresholds", + "documentation":"

A LoadBasedAutoscalingInstruction object that describes the upscaling configuration, which defines how and when AWS OpsWorks increases the number of instances.

" + }, + "DownScaling":{ + "shape":"AutoScalingThresholds", + "documentation":"

A LoadBasedAutoscalingInstruction object that describes the downscaling configuration, which defines how and when AWS OpsWorks reduces the number of instances.

" + } + }, + "documentation":"

Describes a layer's load-based auto scaling configuration.

" + }, + "LoadBasedAutoScalingConfigurations":{ + "type":"list", + "member":{"shape":"LoadBasedAutoScalingConfiguration"} + }, + "Minute":{ + "type":"integer", + "min":1, + "max":100, + "box":true + }, + "Permission":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

A stack ID.

" + }, + "IamUserArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.

" + }, + "AllowSsh":{ + "shape":"Boolean", + "documentation":"

Whether the user can use SSH.

" + }, + "AllowSudo":{ + "shape":"Boolean", + "documentation":"

Whether the user can use sudo.

" + }, + "Level":{ + "shape":"String", + "documentation":"

The user's permission level, which must be the following:

For more information on the permissions associated with these levels, see Managing User Permissions

" + } + }, + "documentation":"

Describes stack or user permissions.

" + }, + "Permissions":{ + "type":"list", + "member":{"shape":"Permission"} + }, + "RaidArray":{ + "type":"structure", + "members":{ + "RaidArrayId":{ + "shape":"String", + "documentation":"

The array ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The array name.

" + }, + "RaidLevel":{ + "shape":"Integer", + "documentation":"

The RAID level.

" + }, + "NumberOfDisks":{ + "shape":"Integer", + "documentation":"

The number of disks in the array.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The array's size.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The array's Linux device. For example /dev/mdadm0.

" + }, + "MountPoint":{ + "shape":"String", + "documentation":"

The array's mount point.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The array's Availability Zone. For more information, see Regions and Endpoints.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

When the RAID array was created.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type, standard or PIOPS.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

For PIOPS volumes, the IOPS per disk.

" + } + }, + "documentation":"

Describes an instance's RAID array.

" + }, + "RaidArrays":{ + "type":"list", + "member":{"shape":"RaidArray"} + }, + "RdsDbInstance":{ + "type":"structure", + "members":{ + "RdsDbInstanceArn":{ + "shape":"String", + "documentation":"

The instance's ARN.

" + }, + "DbInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier.

" + }, + "DbUser":{ + "shape":"String", + "documentation":"

The master user name.

" + }, + "DbPassword":{ + "shape":"String", + "documentation":"

The database password.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The instance's AWS region.

" + }, + "Address":{ + "shape":"String", + "documentation":"

The instance's address.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The instance's database engine.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The ID of the stack that the instance is registered with.

" + }, + "MissingOnRds":{ + "shape":"Boolean", + "documentation":"

Set to true if AWS OpsWorks was unable to discover the Amazon RDS instance. AWS OpsWorks attempts to discover the instance only once. If this value is set to true, you must deregister the instance and then register it again.

" + } + }, + "documentation":"

Describes an Amazon RDS instance.

" + }, + "RdsDbInstances":{ + "type":"list", + "member":{"shape":"RdsDbInstance"} + }, + "RebootInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "Recipes":{ + "type":"structure", + "members":{ + "Setup":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a setup event.

" + }, + "Configure":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a configure event.

" + }, + "Deploy":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a deploy event.

" + }, + "Undeploy":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a undeploy event.

" + }, + "Shutdown":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a shutdown event.

" + } + }, + "documentation":"

AWS OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

" + }, + "RegisterElasticIpRequest":{ + "type":"structure", + "required":[ + "ElasticIp", + "StackId" + ], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "RegisterElasticIpResult":{ + "type":"structure", + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + } + }, + "documentation":"

Contains the response to a RegisterElasticIp request.

" + }, + "RegisterRdsDbInstanceRequest":{ + "type":"structure", + "required":[ + "StackId", + "RdsDbInstanceArn", + "DbUser", + "DbPassword" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "RdsDbInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon RDS instance's ARN.

" + }, + "DbUser":{ + "shape":"String", + "documentation":"

The database's master user name.

" + }, + "DbPassword":{ + "shape":"String", + "documentation":"

The database password.

" + } + } + }, + "RegisterVolumeRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "Ec2VolumeId":{ + "shape":"String", + "documentation":"

The Amazon EBS volume ID.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "RegisterVolumeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + } + }, + "documentation":"

Contains the response to a RegisterVolume request.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The exception message.

" + } + }, + "exception":true, + "documentation":"

Indicates that a resource was not found.

" + }, + "RootDeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "SelfUserProfile":{ + "type":"structure", + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The user's name.

" + }, + "SshUsername":{ + "shape":"String", + "documentation":"

The user's SSH user name.

" + }, + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's SSH public key.

" + } + }, + "documentation":"

Describes a user's SSH information.

" + }, + "ServiceError":{ + "type":"structure", + "members":{ + "ServiceErrorId":{ + "shape":"String", + "documentation":"

The error ID.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "Type":{ + "shape":"String", + "documentation":"

The error type.

" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that describes the error.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

When the error occurred.

" + } + }, + "documentation":"

Describes an AWS OpsWorks service error.

" + }, + "ServiceErrors":{ + "type":"list", + "member":{"shape":"ServiceError"} + }, + "SetLoadBasedAutoScalingRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Enable":{ + "shape":"Boolean", + "documentation":"

Enables load-based auto scaling for the layer.

" + }, + "UpScaling":{ + "shape":"AutoScalingThresholds", + "documentation":"

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.

" + }, + "DownScaling":{ + "shape":"AutoScalingThresholds", + "documentation":"

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.

" + } + } + }, + "SetPermissionRequest":{ + "type":"structure", + "required":[ + "StackId", + "IamUserArn" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + }, + "AllowSsh":{ + "shape":"Boolean", + "documentation":"

The user is allowed to use SSH to communicate with the instance.

" + }, + "AllowSudo":{ + "shape":"Boolean", + "documentation":"

The user is allowed to use sudo to elevate privileges.

" + }, + "Level":{ + "shape":"String", + "documentation":"

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

For more information on the permissions associated with these levels, see Managing User Permissions

" + } + } + }, + "SetTimeBasedAutoScalingRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "AutoScalingSchedule":{ + "shape":"WeeklyAutoScalingSchedule", + "documentation":"

An AutoScalingSchedule with the instance schedule.

" + } + } + }, + "Source":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"SourceType", + "documentation":"

The repository type.

" + }, + "Url":{ + "shape":"String", + "documentation":"

The source URL.

" + }, + "Username":{ + "shape":"String", + "documentation":"

This parameter depends on the repository type.

" + }, + "Password":{ + "shape":"String", + "documentation":"

This parameter depends on the repository type.

For more information on how to safely handle IAM credentials, see .

" + }, + "SshKey":{ + "shape":"String", + "documentation":"

The repository's SSH key.

" + }, + "Revision":{ + "shape":"String", + "documentation":"

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

" + } + }, + "documentation":"

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

" + }, + "SourceType":{ + "type":"string", + "enum":[ + "git", + "svn", + "archive", + "s3" + ] + }, + "SslConfiguration":{ + "type":"structure", + "required":[ + "Certificate", + "PrivateKey" + ], + "members":{ + "Certificate":{ + "shape":"String", + "documentation":"

The contents of the certificate's domain.crt file.

" + }, + "PrivateKey":{ + "shape":"String", + "documentation":"

The private key; the contents of the certificate's domain.kex file.

" + }, + "Chain":{ + "shape":"String", + "documentation":"

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

" + } + }, + "documentation":"

Describes an app's SSL configuration.

" + }, + "Stack":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The stack name.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The stack's ARN.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The VPC ID, if the stack is running in a VPC.

" + }, + "Attributes":{ + "shape":"StackAttributes", + "documentation":"

The stack's attributes.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The stack AWS Identity and Access Management (IAM) role.

" + }, + "DefaultInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultOs":{ + "shape":"String", + "documentation":"

The stack's default operating system, which must be set to Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. The default option is Amazon Linux.

" + }, + "HostnameTheme":{ + "shape":"String", + "documentation":"

The stack host name theme, with spaces replaced by underscores.

" + }, + "DefaultAvailabilityZone":{ + "shape":"String", + "documentation":"

The stack's default Availability Zone. For more information, see Regions and Endpoints.

" + }, + "DefaultSubnetId":{ + "shape":"String", + "documentation":"

The default subnet ID, if the stack is running in a VPC.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager.

" + }, + "ChefConfiguration":{ + "shape":"ChefConfiguration", + "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

" + }, + "UseCustomCookbooks":{ + "shape":"Boolean", + "documentation":"

Whether the stack uses custom cookbooks.

" + }, + "UseOpsworksSecurityGroups":{ + "shape":"Boolean", + "documentation":"

Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.

" + }, + "CustomCookbooksSource":{"shape":"Source"}, + "DefaultSshKeyName":{ + "shape":"String", + "documentation":"

A default SSH key for the stack's instances. You can override this value when you create or update an instance.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

Date when the stack was created.

" + }, + "DefaultRootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + } + }, + "documentation":"

Describes a stack.

" + }, + "StackAttributes":{ + "type":"map", + "key":{"shape":"StackAttributesKeys"}, + "value":{"shape":"String"} + }, + "StackAttributesKeys":{ + "type":"string", + "enum":["Color"] + }, + "StackConfigurationManager":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name. This parameter must be set to \"Chef\".

" + }, + "Version":{ + "shape":"String", + "documentation":"

The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.

" + } + }, + "documentation":"

Describes the configuration manager.

" + }, + "StackSummary":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The stack name.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The stack's ARN.

" + }, + "LayersCount":{ + "shape":"Integer", + "documentation":"

The number of layers.

" + }, + "AppsCount":{ + "shape":"Integer", + "documentation":"

The number of apps.

" + }, + "InstancesCount":{ + "shape":"InstancesCount", + "documentation":"

An InstancesCount object with the number of instances in each status.

" + } + }, + "documentation":"

Summarizes the number of layers, instances, and apps in a stack.

" + }, + "Stacks":{ + "type":"list", + "member":{"shape":"Stack"} + }, + "StartInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "StartStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "StopInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "StopStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "String":{"type":"string"}, + "Strings":{ + "type":"list", + "member":{"shape":"String"} + }, + "Switch":{"type":"string"}, + "TimeBasedAutoScalingConfiguration":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "AutoScalingSchedule":{ + "shape":"WeeklyAutoScalingSchedule", + "documentation":"

A WeeklyAutoScalingSchedule object with the instance schedule.

" + } + }, + "documentation":"

Describes an instance's time-based auto scaling configuration.

" + }, + "TimeBasedAutoScalingConfigurations":{ + "type":"list", + "member":{"shape":"TimeBasedAutoScalingConfiguration"} + }, + "UnassignVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + } + } + }, + "UpdateAppRequest":{ + "type":"structure", + "required":["AppId"], + "members":{ + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The app name.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the app.

" + }, + "DataSources":{ + "shape":"DataSources", + "documentation":"

The app's data sources.

" + }, + "Type":{ + "shape":"AppType", + "documentation":"

The app type.

" + }, + "AppSource":{ + "shape":"Source", + "documentation":"

A Source object that specifies the app repository.

" + }, + "Domains":{ + "shape":"Strings", + "documentation":"

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

" + }, + "EnableSsl":{ + "shape":"Boolean", + "documentation":"

Whether SSL is enabled for the app.

" + }, + "SslConfiguration":{ + "shape":"SslConfiguration", + "documentation":"

An SslConfiguration object with the SSL configuration.

" + }, + "Attributes":{ + "shape":"AppAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "Environment":{ + "shape":"EnvironmentVariables", + "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instances.

" + } + } + }, + "UpdateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The address.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The new name.

" + } + } + }, + "UpdateInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

The instance's layer IDs.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

" + }, + "AutoScalingType":{ + "shape":"AutoScalingType", + "documentation":"

The instance's auto scaling type, which has three possible values:

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The instance host name.

" + }, + "Os":{ + "shape":"String", + "documentation":"

The instance operating system, which must be set to one of the following.

The default option is Amazon Linux. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

" + }, + "AmiId":{ + "shape":"String", + "documentation":"

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances

" + }, + "SshKeyName":{ + "shape":"String", + "documentation":"

The instance SSH key name.

" + }, + "Architecture":{ + "shape":"Architecture", + "documentation":"

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Whether this is an Amazon EBS-optimized instance.

" + } + } + }, + "UpdateLayerRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The layer name, which is used by the console.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

" + }, + "Attributes":{ + "shape":"LayerAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "CustomInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "CustomSecurityGroupIds":{ + "shape":"Strings", + "documentation":"

An array containing the layer's custom security group IDs.

" + }, + "Packages":{ + "shape":"Strings", + "documentation":"

An array of Package objects that describe the layer's packages.

" + }, + "VolumeConfigurations":{ + "shape":"VolumeConfigurations", + "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + }, + "EnableAutoHealing":{ + "shape":"Boolean", + "documentation":"

Whether to disable auto healing for the layer.

" + }, + "AutoAssignElasticIps":{ + "shape":"Boolean", + "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "AutoAssignPublicIps":{ + "shape":"Boolean", + "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "CustomRecipes":{ + "shape":"Recipes", + "documentation":"

A LayerCustomRecipes object that specifies the layer's custom recipes.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

" + }, + "UseEbsOptimizedInstances":{ + "shape":"Boolean", + "documentation":"

Whether to use Amazon EBS-optimized instances.

" + } + } + }, + "UpdateMyUserProfileRequest":{ + "type":"structure", + "members":{ + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's SSH public key.

" + } + } + }, + "UpdateRdsDbInstanceRequest":{ + "type":"structure", + "required":["RdsDbInstanceArn"], + "members":{ + "RdsDbInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon RDS instance's ARN.

" + }, + "DbUser":{ + "shape":"String", + "documentation":"

The master user name.

" + }, + "DbPassword":{ + "shape":"String", + "documentation":"

The database password.

" + } + } + }, + "UpdateStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The stack's new name.

" + }, + "Attributes":{ + "shape":"StackAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultOs":{ + "shape":"String", + "documentation":"

The stack's default operating system, which must be set to Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. The default option is Amazon Linux.

" + }, + "HostnameTheme":{ + "shape":"String", + "documentation":"

The stack's new host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" + }, + "DefaultAvailabilityZone":{ + "shape":"String", + "documentation":"

The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

" + }, + "DefaultSubnetId":{ + "shape":"String", + "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.

" + }, + "ChefConfiguration":{ + "shape":"ChefConfiguration", + "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + }, + "UseCustomCookbooks":{ + "shape":"Boolean", + "documentation":"

Whether the stack uses custom cookbooks.

" + }, + "CustomCookbooksSource":{"shape":"Source"}, + "DefaultSshKeyName":{ + "shape":"String", + "documentation":"

A default SSH key for the stack instances. You can override this value when you create or update an instance.

" + }, + "DefaultRootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + }, + "UseOpsworksSecurityGroups":{ + "shape":"Boolean", + "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

For more information, see Create a New Stack.

" + } + } + }, + "UpdateUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user IAM ARN.

" + }, + "SshUsername":{ + "shape":"String", + "documentation":"

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.

" + }, + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's new SSH public key.

" + }, + "AllowSelfManagement":{ + "shape":"Boolean", + "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

" + } + } + }, + "UpdateVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The new name.

" + }, + "MountPoint":{ + "shape":"String", + "documentation":"

The new mount point.

" + } + } + }, + "UserProfile":{ + "type":"structure", + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The user's name.

" + }, + "SshUsername":{ + "shape":"String", + "documentation":"

The user's SSH user name.

" + }, + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's SSH public key.

" + }, + "AllowSelfManagement":{ + "shape":"Boolean", + "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

" + } + }, + "documentation":"

Describes a user's SSH information.

" + }, + "UserProfiles":{ + "type":"list", + "member":{"shape":"UserProfile"} + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The exception message.

" + } + }, + "exception":true, + "documentation":"

Indicates that a request was invalid.

" + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "paravirtual", + "hvm" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + }, + "Ec2VolumeId":{ + "shape":"String", + "documentation":"

The Amazon EC2 volume ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The volume name.

" + }, + "RaidArrayId":{ + "shape":"String", + "documentation":"

The RAID array ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The value returned by DescribeVolumes.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The volume size.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "MountPoint":{ + "shape":"String", + "documentation":"

The volume mount point. For example \"/dev/sdh\".

" + }, + "Region":{ + "shape":"String", + "documentation":"

The AWS region. For more information about AWS regions, see Regions and Endpoints.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The volume Availability Zone. For more information, see Regions and Endpoints.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type, standard or PIOPS.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

For PIOPS volumes, the IOPS per disk.

" + } + }, + "documentation":"

Describes an instance's Amazon EBS volume.

" + }, + "VolumeConfiguration":{ + "type":"structure", + "required":[ + "MountPoint", + "NumberOfDisks", + "Size" + ], + "members":{ + "MountPoint":{ + "shape":"String", + "documentation":"

The volume mount point. For example \"/dev/sdh\".

" + }, + "RaidLevel":{ + "shape":"Integer", + "documentation":"

The volume RAID level.

" + }, + "NumberOfDisks":{ + "shape":"Integer", + "documentation":"

The number of disks in the volume.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The volume size.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type: standard, PIOPS, or gp2.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

For PIOPS volumes, the IOPS per disk.

" + } + }, + "documentation":"

Describes an Amazon EBS volume configuration.

" + }, + "VolumeConfigurations":{ + "type":"list", + "member":{"shape":"VolumeConfiguration"} + }, + "Volumes":{ + "type":"list", + "member":{"shape":"Volume"} + }, + "WeeklyAutoScalingSchedule":{ + "type":"structure", + "members":{ + "Monday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Monday.

" + }, + "Tuesday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Tuesday.

" + }, + "Wednesday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Wednesday.

" + }, + "Thursday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Thursday.

" + }, + "Friday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Friday.

" + }, + "Saturday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Saturday.

" + }, + "Sunday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Sunday.

" + } + }, + "documentation":"

Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.

The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.

The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.

{ \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" }

" + } + } +} diff --git a/apis/opsworks-2013-02-18.paginators.json b/apis/opsworks-2013-02-18.paginators.json new file mode 100644 index 0000000000..c342768a61 --- /dev/null +++ b/apis/opsworks-2013-02-18.paginators.json @@ -0,0 +1,49 @@ +{ + "pagination": { + "DescribeApps": { + "result_key": "Apps" + }, + "DescribeCommands": { + "result_key": "Commands" + }, + "DescribeDeployments": { + "result_key": "Deployments" + }, + "DescribeElasticIps": { + "result_key": "ElasticIps" + }, + "DescribeElasticLoadBalancers": { + "result_key": "ElasticLoadBalancers" + }, + "DescribeInstances": { + "result_key": "Instances" + }, + "DescribeLayers": { + "result_key": "Layers" + }, + "DescribeLoadBasedAutoScaling": { + "result_key": "LoadBasedAutoScalingConfigurations" + }, + "DescribePermissions": { + "result_key": "Permissions" + }, + "DescribeRaidArrays": { + "result_key": "RaidArrays" + }, + "DescribeServiceErrors": { + "result_key": "ServiceErrors" + }, + "DescribeStacks": { + "result_key": "Stacks" + }, + "DescribeTimeBasedAutoScaling": { + "result_key": "TimeBasedAutoScalingConfigurations" + }, + "DescribeUserProfiles": { + "result_key": "UserProfiles" + }, + "DescribeVolumes": { + "result_key": "Volumes" + } + } +} diff --git a/apis/rds-2013-01-10.api.json b/apis/rds-2013-01-10.api.json new file mode 100644 index 0000000000..a52160e7b3 --- /dev/null +++ b/apis/rds-2013-01-10.api.json @@ -0,0 +1,1920 @@ +{ + "metadata": { + "apiVersion": "2013-01-10", + "endpointPrefix": "rds", + "serviceAbbreviation": "Amazon RDS", + "serviceFullName": "Amazon Relational Database Service", + "signatureVersion": "v2", + "xmlNamespace": "http://rds.amazonaws.com/doc/2013-01-10/", + "protocol": "query" + }, + "operations": { + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "AuthorizeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AuthorizeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CopyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members": { + "SourceDBSnapshotIdentifier": {}, + "TargetDBSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CopyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBInstanceReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SourceDBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "AvailabilityZone": {}, + "Port": { + "type": "integer" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBInstanceReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "S1c" + } + } + } + }, + "CreateDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members": { + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSecurityGroupResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CreateDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1i" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "SourceIds": { + "shape": "S5" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "CreateOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members": { + "OptionGroupName": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "OptionGroupDescription": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1o" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {} + } + } + }, + "DeleteDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "DeleteOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {} + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S25" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S25", + "locationName": "CharacterSet" + } + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "St", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "S1c", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2f" + }, + "Marker": {} + } + } + }, + "DescribeDBSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSecurityGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "DBSecurityGroup" + } + } + } + } + }, + "DescribeDBSnapshots": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "SnapshotType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSnapshots": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "DBSnapshot" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S11", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2f" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {} + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S6" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S6" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S6" + }, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeOptionGroupOptions": { + "input": { + "type": "structure", + "required": [ + "EngineName" + ], + "members": { + "EngineName": {}, + "MajorEngineVersion": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupOptionsResult", + "type": "structure", + "members": { + "OptionGroupOptions": { + "type": "list", + "member": { + "locationName": "OptionGroupOption", + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "MinimumRequiredMinorEngineVersion": {}, + "PortRequired": { + "type": "boolean" + }, + "DefaultPort": { + "type": "integer" + }, + "OptionsDependedOn": { + "type": "list", + "member": { + "locationName": "OptionName" + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeOptionGroups": { + "input": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "EngineName": {}, + "MajorEngineVersion": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupsResult", + "type": "structure", + "members": { + "OptionGroupsList": { + "type": "list", + "member": { + "shape": "S1o", + "locationName": "OptionGroup" + } + }, + "Marker": {} + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S14", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedDBInstances": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstances": { + "type": "list", + "member": { + "shape": "S3m", + "locationName": "ReservedDBInstance" + } + } + } + } + }, + "DescribeReservedDBInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstancesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedDBInstancesOffering", + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "RecurringCharges": { + "shape": "S3o" + } + }, + "wrapper": true + } + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {} + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "S9" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S2f" + } + } + }, + "output": { + "shape": "S3z", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1i" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "ModifyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {}, + "OptionsToInclude": { + "type": "list", + "member": { + "locationName": "OptionConfiguration", + "type": "structure", + "required": [ + "OptionName" + ], + "members": { + "OptionName": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "Sp" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sq" + } + } + } + }, + "OptionsToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1o" + } + } + } + }, + "PromoteReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "PromoteReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "PurchaseReservedDBInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedDBInstancesOfferingId" + ], + "members": { + "ReservedDBInstancesOfferingId": {}, + "ReservedDBInstanceId": {}, + "DBInstanceCount": { + "type": "integer" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "PurchaseReservedDBInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedDBInstance": { + "shape": "S3m" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2f" + } + } + }, + "output": { + "shape": "S3z", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBInstanceFromDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RestoreDBInstanceFromDBSnapshotResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RestoreDBInstanceToPointInTime": { + "input": { + "type": "structure", + "required": [ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members": { + "SourceDBInstanceIdentifier": {}, + "TargetDBInstanceIdentifier": {}, + "RestoreTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RestoreDBInstanceToPointInTimeResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RevokeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RevokeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "Id": {}, + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S5" + }, + "EventCategoriesList": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S5": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S6": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S9": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sd": { + "type": "structure", + "members": { + "OwnerId": {}, + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "VpcId": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "Iops": { + "type": "integer" + } + }, + "wrapper": true + }, + "Sp": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "Sq": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "St": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "shape": "Sv" + }, + "VpcSecurityGroups": { + "shape": "Sx" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S11" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {} + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMembership": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "type": "boolean" + } + }, + "wrapper": true + }, + "Sv": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "Sx": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S11": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S14" + }, + "SubnetStatus": {} + } + } + } + }, + "wrapper": true + }, + "S14": { + "type": "structure", + "members": { + "Name": {}, + "ProvisionedIopsCapable": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S1c": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S1i": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1o": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "OptionGroupDescription": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "Options": { + "type": "list", + "member": { + "locationName": "Option", + "type": "structure", + "members": { + "OptionName": {}, + "OptionDescription": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "Sv" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sx" + } + } + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "type": "boolean" + }, + "VpcId": {} + }, + "wrapper": true + }, + "S25": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S2f": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S3m": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "DBInstanceCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "State": {}, + "RecurringCharges": { + "shape": "S3o" + } + }, + "wrapper": true + }, + "S3o": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S3z": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/apis/rds-2013-01-10.full.json b/apis/rds-2013-01-10.full.json new file mode 100644 index 0000000000..6c4f48ccde --- /dev/null +++ b/apis/rds-2013-01-10.full.json @@ -0,0 +1,6074 @@ +{ + "metadata":{ + "apiVersion":"2013-01-10", + "endpointPrefix":"rds", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "signatureVersion":"v2", + "xmlNamespace":"http://rds.amazonaws.com/doc/2013-01-10/", + "protocol":"query" + }, + "documentation":"Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code, applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB Instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This is the Amazon RDS API Reference. It contains a comprehensive description of all Amazon RDS Query APIs and data types. Note that this API is asynchronous and some actions may require polling to determine when an action has been applied. See the parameter description to determine if a change is applied immediately or on the next instance reboot or during the maintenance window. To get started with Amazon RDS, go to the Amazon RDS Getting Started Guide. For more information on Amazon RDS concepts and usage scenarios, go to the Amazon RDS User Guide.

", + "operations":{ + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddSourceIdentifierToSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Adds a source identifier to an existing RDS event notification subscription.

" + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddTagsToResourceMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Adds metadata tags to a DB Instance. These tags can also be used with cost allocation reporting to track cost associated with a DB Instance.

For an overview on tagging DB Instances, see DB Instance Tags.

" + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AuthorizeDBSecurityGroupIngressMessage", + "documentation":"

" + }, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"AuthorizationAlreadyExistsFault", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

" + }, + { + "shape":"AuthorizationQuotaExceededFault", + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB security group authorization quota has been reached.

" + } + ], + "documentation":"

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopyDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"CopyDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.

" + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Creates a new DB instance.

" + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Creates a DB Instance that acts as a Read Replica of a source DB Instance.

All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except as specified below.

The source DB Instance must have backup retention enabled.

" + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBParameterGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupQuotaExceededFault", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" + }, + { + "shape":"DBParameterGroupAlreadyExistsFault", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB parameter group with the same name exists.

" + } + ], + "documentation":"

Creates a new DB Parameter Group.

A DB Parameter Group is initially created with the default parameters for the database engine used by the DB Instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB Parameter Group, you need to associate it with your DB Instance using ModifyDBInstance. When you associate a new DB Parameter Group with a running DB Instance, you need to reboot the DB Instance for the new DB Parameter Group and associated settings to take effect.

" + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSecurityGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupAlreadyExistsFault", + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

" + }, + { + "shape":"DBSecurityGroupQuotaExceededFault", + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

" + }, + { + "shape":"DBSecurityGroupNotSupportedFault", + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group is not allowed for this action.

" + } + ], + "documentation":"

Creates a new DB Security Group. DB Security Groups control access to a DB Instance.

" + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

" + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSubnetGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupAlreadyExistsFault", + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupQuotaExceededFault", + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

" + }, + { + "shape":"DBSubnetQuotaExceededFault", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + } + ], + "documentation":"

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + { + "shape":"SubscriptionAlreadyExistFault", + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied subscription name already exists.

" + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

" + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateOptionGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateOptionGroupResult", + "wrapper":true, + "documentation":"

", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + { + "shape":"OptionGroupAlreadyExistsFault", + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group you are trying to create already exists.

" + }, + { + "shape":"OptionGroupQuotaExceededFault", + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" + } + ], + "documentation":"

Creates a new Option Group.

" + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the request was received correctly. If a final DBSnapshot is requested the status of the RDS instance will be \"deleting\" until the DBSnapshot is created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.

" + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBParameterGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.

" + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSecurityGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + } + ], + "documentation":"

Deletes a DB Security Group.

" + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Deletes a DBSnapshot.

" + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSubnetGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBSubnetGroupStateFault", + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet group cannot be deleted because it is in use.

" + }, + { + "shape":"InvalidDBSubnetStateFault", + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is not in the available state.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + } + ], + "documentation":"

Deletes a DB subnet group.

" + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"InvalidEventSubscriptionStateFault", + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

" + } + ], + "documentation":"

Deletes an RDS event notification subscription.

" + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteOptionGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + { + "shape":"InvalidOptionGroupStateFault", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + } + ], + "documentation":"

Deletes an existing Option Group.

" + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

", + "resultWrapper":"DescribeDBEngineVersionsResult" + }, + "documentation":"

Returns a list of the available DB engines.

" + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBInstancesMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBInstanceMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Returns information about provisioned RDS instances. This API supports pagination.

" + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBParameterGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup.

" + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Returns the detailed parameter list for a particular DBParameterGroup.

" + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSecurityGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSecurityGroupMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + } + ], + "documentation":"

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSnapshotsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSnapshotMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Returns information about DBSnapshots. This API supports pagination.

" + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSubnetGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSubnetGroupMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + } + ], + "documentation":"

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEngineDefaultParametersMessage", + "documentation":"

" + }, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "documentation":"

Returns the default engine and system parameter information for the specified database engine.

" + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventCategoriesMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventCategoriesMessage", + "documentation":"

Data returned from the DescribeEventCategories action.

", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

" + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventSubscriptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventSubscriptionsMessage", + "documentation":"

Data returned by the DescribeEventSubscriptions action.

", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + } + ], + "documentation":"

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventsMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

Returns events related to DB instances, DB security groups, DB Snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB Iinstance, DB security group, DB Snapshot, or DB parameter group can be obtained by providing the source identifier as a parameter. By default, the past hour of events are returned.

You can see a list of event categories and source types in the Events topic in the Amazon RDS User Guide.

" + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOptionGroupOptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OptionGroupOptionsMessage", + "documentation":"

", + "resultWrapper":"DescribeOptionGroupOptionsResult" + }, + "documentation":"

Describes all available options.

" + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOptionGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OptionGroups", + "documentation":"

List of option groups.

", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Describes the available option groups.

" + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOrderableDBInstanceOptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + }, + "documentation":"

Returns a list of orderable DB Instance options for the specified engine.

" + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedDBInstancesMessage", + "documentation":"

" + }, + "output":{ + "shape":"ReservedDBInstanceMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + { + "shape":"ReservedDBInstanceNotFoundFault", + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified reserved DB Instance not found.

" + } + ], + "documentation":"

Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.

" + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedDBInstancesOfferingsMessage", + "documentation":"

" + }, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + { + "shape":"ReservedDBInstancesOfferingNotFoundFault", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + } + ], + "documentation":"

Lists available reserved DB Instance offerings.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListTagsForResourceMessage", + "documentation":"

" + }, + "output":{ + "shape":"TagListMessage", + "documentation":"

", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Lists all tags on a DB Instance.

For an overview on tagging DB Instances, see DB Instance Tags.

" + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + { + "shape":"DBUpgradeDependencyFailureFault", + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

" + } + ], + "documentation":"

Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupNameMessage", + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + } + ], + "documentation":"

Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

" + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBSubnetGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetQuotaExceededFault", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + { + "shape":"SubnetAlreadyInUse", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is already in use in the Availability Zone.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + } + ], + "documentation":"

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + } + ], + "documentation":"

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyOptionGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyOptionGroupResult", + "wrapper":true, + "documentation":"

", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + { + "shape":"InvalidOptionGroupStateFault", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Modifies an existing Option Group.

" + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PromoteReadReplicaMessage", + "documentation":"

" + }, + "output":{ + "shape":"PromoteReadReplicaResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Promotes a Read Replica DB Instance to a standalone DB Instance.

" + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PurchaseReservedDBInstancesOfferingMessage", + "documentation":"

" + }, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + { + "shape":"ReservedDBInstancesOfferingNotFoundFault", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + }, + { + "shape":"ReservedDBInstanceAlreadyExistsFault", + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a reservation with the given identifier.

" + }, + { + "shape":"ReservedDBInstanceQuotaExceededFault", + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would exceed the user's DB Instance quota.

" + } + ], + "documentation":"

Purchases a reserved DB Instance offering.

" + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RebootDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"RebootDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed.

" + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveSourceIdentifierFromSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Removes a source identifier from an existing RDS event notification subscription.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTagsFromResourceMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Removes metadata tags from a DB Instance.

For an overview on tagging DB Instances, see DB Instance Tags.

" + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ResetDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupNameMessage", + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

" + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreDBInstanceFromDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Creates a new DB Instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.

" + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreDBInstanceToPointInTimeMessage", + "documentation":"

" + }, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"PointInTimeRestoreNotEnabledFault", + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.

" + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RevokeDBSecurityGroupIngressMessage", + "documentation":"

" + }, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + } + ], + "documentation":"

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

" + } + }, + "shapes":{ + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to add a source identifier to.

" + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

" + } + }, + "documentation":"

" + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The DB Instance the tags will be added to.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB Instance.

" + } + }, + "documentation":"

" + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

" + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

" + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB security group authorization quota has been reached.

" + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group to add authorization to.

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

The IP range to authorize.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "documentation":"

" + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the availability zone.

" + }, + "ProvisionedIopsCapable":{ + "shape":"Boolean", + "documentation":"

True indicates the availability zone is capable of provisioned IOPs.

" + } + }, + "wrapper":true, + "documentation":"

Contains Availability Zone information.

This data type is used as an element in the following data type:

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{ + "shape":"String", + "documentation":"

The name of the character set.

" + }, + "CharacterSetDescription":{ + "shape":"String", + "documentation":"

The description of the character set.

" + } + }, + "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the source DB snapshot.

Constraints:

Example: rds:mydb-2012-04-02-00-01

" + }, + "TargetDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the copied snapshot.

Constraints:

Example: my-db-snapshot

" + } + }, + "documentation":"

" + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORCL

Constraints:

SQL Server

Not applicable. Must be null.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

Example: mydbinstance

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

SQL Server

Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the DB Instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine to be used for this instance.

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

The name of master user for the client DB Instance.

MySQL

Constraints:

Type: String

Oracle

Constraints:

SQL Server

Constraints:

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The password for the master database user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".

Type: String

MySQL

Constraints: Must contain from 8 to 41 alphanumeric characters.

Oracle

Constraints: Must contain from 8 to 30 alphanumeric characters.

SQL Server

Constraints: Must contain from 8 to 128 alphanumeric characters.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC Security Groups to associate with this DB Instance.

Default: The default EC2 VPC Security Group for the DB Subnet group's VPC.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434 and 3389.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to use.

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

Type: String

SQL Server

Example: 10.50.2789.0.v1

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Indicates that the DB Instance should be associated with the specified option group.

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet.

" + }, + "PubliclyAccessible":{"shape":"BooleanOptional"} + }, + "documentation":"

" + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

" + }, + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

" + }, + "PubliclyAccessible":{"shape":"BooleanOptional"} + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

Constraints:

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The DB Parameter Group Family name. A DB Parameter Group can be associated with one and only one DB Parameter Group Family, and can be applied only to a DB Instance running a database engine and engine version compatible with that DB Parameter Group Family.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the DB Parameter Group.

" + } + }, + "documentation":"

" + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name for the DB Security Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mysecuritygroup

" + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB Security Group.

" + } + }, + "documentation":"

" + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB Snapshot.

Constraints:

Example: my-snapshot-id

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This is the unique key that identifies a DB Instance. This parameter isn't case sensitive.

Constraints:

" + } + }, + "documentation":"

" + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB Subnet Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB Subnet Group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 Subnet IDs for the DB Subnet Group.

" + } + }, + "documentation":"

" + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the subscription.

Constraints: The name must be less than 255 characters.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

" + } + }, + "documentation":"

" + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the option group to be created.

Constraints:

Example: myOptiongroup

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Specifies the name of the engine that this option group should be associated with.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Specifies the major version of the engine that this option group should be associated with.

" + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

The description of the option group.

" + } + }, + "documentation":"

" + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DBParameterGroupFamily for the database engine.

" + }, + "DBEngineDescription":{ + "shape":"String", + "documentation":"

The description of the database engine.

" + }, + "DBEngineVersionDescription":{ + "shape":"String", + "documentation":"

The description of the database engine version.

" + }, + "DefaultCharacterSet":{ + "shape":"CharacterSet", + "documentation":"

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

" + }, + "SupportedCharacterSets":{ + "shape":"SupportedCharacterSetsList", + "documentation":"

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

" + } + }, + "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBEngineVersions":{ + "shape":"DBEngineVersionList", + "documentation":"

A list of DBEngineVersion elements.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

" + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the name of the compute and memory capacity class of the DB Instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Provides the name of the database engine to be used for this DB Instance.

" + }, + "DBInstanceStatus":{ + "shape":"String", + "documentation":"

Specifies the current state of this database.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Contains the master username for the DB Instance.

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

Specifies the connection endpoint.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

Specifies the allocated storage size specified in gigabytes.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the date and time the DB Instance was created.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" + }, + "BackupRetentionPeriod":{ + "shape":"Integer", + "documentation":"

Specifies the number of days for which automatic DB Snapshots are retained.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

Provides List of VPC security group elements that the DB Instance belongs to.

" + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupStatusList", + "documentation":"

Provides the list of DB Parameter Groups applied to this DB Instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Specifies the name of the Availability Zone the DB Instance is located in.

" + }, + "DBSubnetGroup":{ + "shape":"DBSubnetGroup", + "documentation":"

Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range (in UTC) during which system maintenance can occur.

" + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that minor version patches are applied automatically.

" + }, + "ReadReplicaSourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

" + }, + "ReadReplicaDBInstanceIdentifiers":{ + "shape":"ReadReplicaDBInstanceIdentifierList", + "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for this DB Instance.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value.

" + }, + "OptionGroupMembership":{ + "shape":"OptionGroupMembership", + "documentation":"

Specifies the name and status of the option group that this instance belongs to.

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

If present, specifies the name of the character set that this instance is associated with.

" + }, + "SecondaryAvailabilityZone":{ + "shape":"String", + "documentation":"

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" + }, + "PubliclyAccessible":{"shape":"Boolean"} + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

" + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "DBInstances":{ + "shape":"DBInstanceList", + "documentation":"

A list of DBInstance instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

" + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

Provides the name of the DB Parameter Group.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides the customer-specified description for this DB Parameter Group.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

" + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB parameter group with the same name exists.

" + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of Parameter instances.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

" + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

" + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DP Parameter Group.

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

The status of parameter updates.

" + } + }, + "documentation":"

The status of the DB Parameter Group.

This data type is used as a response element in the following actions:

" + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupList", + "documentation":"

A list of DBParameterGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

" + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

Provides the AWS ID of the owner of a specific DB Security Group.

" + }, + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the DB Security Group.

" + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the DB Security Group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the VpcId of the DB Security Group.

" + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

Contains a list of EC2SecurityGroup elements.

" + }, + "IPRanges":{ + "shape":"IPRangeList", + "documentation":"

Contains a list of IPRange elements.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

" + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB Security Group.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroups", + "documentation":"

A list of DBSecurityGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

" + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group is not allowed for this action.

" + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

" + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier for the DB Snapshot.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the time (UTC) when the snapshot was taken.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Specifies the name of the database engine.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

Specifies the allocated storage size in gigabytes (GB).

" + }, + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of this DB Snapshot.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the database engine was listening on at the time of the snapshot.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the Vpc Id associated with the DB Snapshot.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

Specifies the time (UTC) when the snapshot was taken.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Provides the master username for the DB Instance.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Specifies the version of the database engine.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB Instance.

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

Provides the type of the DB Snapshot.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

" + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSnapshots":{ + "shape":"DBSnapshotList", + "documentation":"

A list of DBSnapshot instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

" + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the DB Subnet Group.

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the DB Subnet Group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the VpcId of the DB Subnet Group.

" + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

Provides the status of the DB Subnet Group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Contains a list of Subnet elements.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

" + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

" + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSubnetGroups":{ + "shape":"DBSubnetGroups", + "documentation":"

A list of DBSubnetGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

" + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

" + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

" + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier for the DB Instance to be deleted. This parameter isn't case sensitive.

Constraints:

" + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

Determines whether a final DB Snapshot is created before the DB Instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB Snapshot is created before the DB Instance is deleted.

Default: false

" + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group to delete.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DBSnapshot identifier.

Constraints: Must be the name of an existing DB Snapshot in the available state.

" + } + }, + "documentation":"

" + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the database subnet group to delete.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to delete.

" + } + }, + "documentation":"

" + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be deleted.

" + } + }, + "documentation":"

" + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The database engine to return.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The database engine version to return.

Example: 5.1.49

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of a specific DB Parameter Group family to return details for.

Constraints:

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

Indicates that only the default version of the specified engine or engine and major version combination is returned.

" + }, + "ListSupportedCharacterSets":{ + "shape":"BooleanOptional", + "documentation":"

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

" + } + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB Instance is returned. This parameter isn't case sensitive.

Constraints:

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB Parameter Group to return details for.

Constraints:

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB Parameter Group to return details for.

Constraints:

" + }, + "Source":{ + "shape":"String", + "documentation":"

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.

Constraints:

" + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Subnet Group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group Family.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + } + }, + "documentation":"

" + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to describe.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Constraints:

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes to retrieve events for.

Default: 60

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories that trigger notifications for a event notification subscription.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{ + "shape":"String", + "documentation":"

Options available for the given DB engine name to be described.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

If specified, filters the results to include only options for the specified major engine version.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Filters the list of option groups to only include groups associated with a specific database engine.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

" + } + }, + "documentation":"

" + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the engine to retrieve DB Instance options for.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

" + }, + "Vpc":{ + "shape":"BooleanOptional", + "documentation":"

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

The reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "Double":{"type":"double"}, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the EC2 Security Group.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

Specifies the id of the EC2 Security Group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

Specifies the DNS address of the DB Instance.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the database engine is listening on.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Specifies the name of the DB Parameter Group Family which the engine default parameters apply to.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Contains a list of engine default parameters.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

Provides the identifier for the source of the event.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the source type for this event.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Provides the text of this event.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

Specifies the category for the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

Specifies the date and time of the event.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeEvents action.

" + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The source type that the returned categories belong to

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

The event categories for the specified source type

" + } + }, + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventCategories action.

" + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

A list of EventCategoriesMap data types.

" + } + }, + "documentation":"

Data returned from the DescribeEventCategories action.

" + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"

Not used.

" + }, + "CustomerAwsId":{ + "shape":"String", + "documentation":"

The AWS customer account associated with the RDS event notification subscription.

" + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

The RDS event notification subscription Id.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The topic ARN of the RDS event notification subscription.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + }, + "SubscriptionCreationTime":{ + "shape":"String", + "documentation":"

The time the RDS event notification subscription was created.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The source type for the RDS event notification subscription.

" + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

A list of source Ids for the RDS event notification subscription.

" + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for the RDS event notification subscription.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" + } + }, + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

A list of EventSubscriptions data types.

" + } + }, + "documentation":"

Data returned by the DescribeEventSubscriptions action.

" + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

A list of Event instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

" + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

Specifies the IP range.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet group cannot be deleted because it is in use.

" + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is not in the available state.

" + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

" + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The DB Instance with tags to be listed.

" + } + }, + "documentation":"

" + }, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This value is stored as a lowercase string.

Constraints:

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The new storage capacity of the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DB Security Groups to authorize on this DB Instance. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

Constraints:

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first. See each parameter to determine when a change is applied.

Default: false

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The new password for the DB Instance master user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

" + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group to apply to this DB Instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Default: Uses existing setting

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB Instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Constraints: Cannot be specified if the DB Instance is a read replica.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

" + }, + "AllowMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Indicates that the DB Instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

" + }, + "NewDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The new DB Instance identifier for the DB Instance when renaming a DB Instance. This value is stored as a lowercase string.

Constraints:

" + } + }, + "documentation":"

" + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

Constraints:

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

" + } + }, + "documentation":"

" + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB Subnet Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB Subnet Group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 Subnet IDs for the DB Subnet Group.

" + } + }, + "documentation":"

" + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription.

" + } + }, + "documentation":"

" + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be modified.

" + }, + "OptionsToInclude":{ + "shape":"OptionConfigurationList", + "documentation":"

Options in this list are added to the Option Group or, if already present, the specified configuration is used to update the existing configuration.

" + }, + "OptionsToRemove":{ + "shape":"OptionNamesList", + "documentation":"

Options in this list are removed from the Option Group.

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the Option Group.

" + } + }, + "documentation":"

" + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

The name of the option.

" + }, + "OptionDescription":{ + "shape":"String", + "documentation":"

The description of the option.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

If required, the port configured for this option to use.

" + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

If the Option requires access to a port, then this DB Security Group allows access to the port.

" + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

If the Option requires access to a port, then this VPC Security Group allows access to the port.

" + } + }, + "documentation":"

Option details.

" + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

The configuration of options to include in a group.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The optional port for the option.

" + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DBSecurityGroupMemebrship name strings used for this option.

" + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of VpcSecurityGroupMemebrship name strings used for this option.

" + } + }, + "documentation":"

A list of all available options

" + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the option group.

" + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the option group.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Engine name that this option group can be applied to.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Indicates the major engine version associated with this option group.

" + }, + "Options":{ + "shape":"OptionsList", + "documentation":"

Indicates what options are available in the option group.

" + }, + "AllowsVpcAndNonVpcInstanceMemberships":{ + "shape":"Boolean", + "documentation":"

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value 'true' indicates the option group can be applied to both VPC and non-VPC instances.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

" + } + }, + "wrapper":true, + "documentation":"

" + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group you are trying to create already exists.

" + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group that the instance belongs to.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

" + } + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the option.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the option.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Engine name that this option can be applied to.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Indicates the major engine version that the option is available for.

" + }, + "MinimumRequiredMinorEngineVersion":{ + "shape":"String", + "documentation":"

The minimum required engine version for the option to be applied.

" + }, + "PortRequired":{ + "shape":"Boolean", + "documentation":"

Specifies whether the option requires a port.

" + }, + "DefaultPort":{ + "shape":"IntegerOptional", + "documentation":"

If the option requires a port, specifies the default port for the option.

" + }, + "OptionsDependedOn":{ + "shape":"OptionsDependedOn", + "documentation":"

List of all options that are prerequisites for this option.

" + } + }, + "documentation":"

Available option.

" + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + }, + "documentation":"

List of available options.

" + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{ + "shape":"OptionGroupsList", + "documentation":"

List of option groups.

" + }, + "Marker":{"shape":"String"} + }, + "documentation":"

List of option groups.

" + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The engine type of the orderable DB Instance.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version of the orderable DB Instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB Instance Class for the orderable DB Instance

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model for the orderable DB Instance.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

A list of availability zones for the orderable DB Instance.

" + }, + "MultiAZCapable":{ + "shape":"Boolean", + "documentation":"

Indicates whether this orderable DB Instance is multi-AZ capable.

" + }, + "ReadReplicaCapable":{ + "shape":"Boolean", + "documentation":"

Indicates whether this orderable DB Instance can have a read replica.

" + }, + "Vpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is a VPC orderable DB Instance.

" + } + }, + "wrapper":true, + "documentation":"

Contains a list of available options for a DB Instance

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{ + "shape":"OrderableDBInstanceOptionsList", + "documentation":"

An OrderableDBInstanceOption structure containing information about orderable options for the DB Instance.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

Specifies the name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

Specifies the value of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides a description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

Indicates the source of the parameter value.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

Specifies the engine specific parameters type.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

Specifies the valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

Specifies the valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest engine version to which the parameter can apply.

" + }, + "ApplyMethod":{ + "shape":"ApplyMethod", + "documentation":"

Indicates when to apply parameter updates.

" + } + }, + "documentation":"

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

" + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceClass for the DB Instance that will be applied or is in progress.

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

Contains the new AllocatedStorage size for the DB Instance that will be applied or is in progress.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

Contains the pending or in-progress change of the master credentials for the DB Instance.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending port for the DB Instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending number of days for which automated backups are retained.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the new Provisioned IOPS value for the DB Instance that will be applied or is being applied.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceIdentifier for the DB Instance that will be applied or is in progress.

" + } + }, + "documentation":"

This data type is used as a response element in the ModifyDBInstance action.

" + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

" + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This value is stored as a lowercase string.

Constraints:

Example: mydbinstance

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

" + } + }, + "documentation":"

" + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved DB Instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

Customer-specified identifier to track this reservation.

Example: myreservationID

" + }, + "DBInstanceCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of instances to reserve.

Default: 1

" + } + }, + "documentation":"

" + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

" + }, + "ForceFailover":{ + "shape":"BooleanOptional", + "documentation":"

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

" + } + }, + "documentation":"

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

" + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

The frequency of the recurring charge.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to remove a source identifier from.

" + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

" + } + }, + "documentation":"

" + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The DB Instance the tags will be removed from.

" + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

The tag key (name) of the tag to be removed.

" + } + }, + "documentation":"

" + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

The unique identifier for the reservation.

" + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class for the reserved DB Instance.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The time the reservation started.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this reserved DB Instance.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this reserved DB Instance.

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved DB Instance.

" + }, + "DBInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of reserved DB Instances.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The description of the reserved DB Instance.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type of this reserved DB Instance.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Indicates if the reservation applies to Multi-AZ deployments.

" + }, + "State":{ + "shape":"String", + "documentation":"

The state of the reserved DB Instance.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved DB Instance.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

" + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a reservation with the given identifier.

" + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReservedDBInstances":{ + "shape":"ReservedDBInstanceList", + "documentation":"

A list of of reserved DB Instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

" + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified reserved DB Instance not found.

" + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would exceed the user's DB Instance quota.

" + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class for the reserved DB Instance.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this offering.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this offering.

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved DB Instance offering.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The database engine used by the offering.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Indicates if the offering applies to Multi-AZ deployments.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved DB Instance.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReservedDBInstancesOfferings":{ + "shape":"ReservedDBInstancesOfferingList", + "documentation":"

A list of reserved DB Instance offerings.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

" + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

Constraints:

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

Specifies whether (true) or not (false) to reset all parameters in the DB Parameter Group to default values.

Default: true

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

" + } + }, + "documentation":"

" + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB Snapshot to restore from.

Constraints:

" + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

Constraints:

Example: my-snapshot-id

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1150-65535

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The DB Subnet Group name to use for the new instance.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB Instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The database name for the restored DB Instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Example: oracle-ee

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{"shape":"String"} + }, + "documentation":"

" + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":[ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members":{ + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the source DB Instance from which to restore.

Constraints:

" + }, + "TargetDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The name of the new database instance to be created.

Constraints:

" + }, + "RestoreTime":{ + "shape":"TStamp", + "documentation":"

The date and time to restore from.

Valid Values: Value must be a UTC time

Constraints:

Example: 2009-09-07T23:45:00Z

" + }, + "UseLatestRestorableTime":{ + "shape":"Boolean", + "documentation":"

Specifies whether (true) or not (false) the DB Instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

Default: The same DBInstanceClass as the original DB Instance.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB Instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The DB subnet group name to use for the new instance.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB Instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The database name for the restored DB Instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Example: oracle-ee

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{"shape":"String"} + }, + "documentation":"

" + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group to revoke ingress from.

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

The id of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "documentation":"

" + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier of the subnet.

" + }, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{ + "shape":"String", + "documentation":"

Specifies the status of the subnet.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeDBSubnetGroups action.

" + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is already in use in the Availability Zone.

" + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied subscription name already exists.

" + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + }, + "Value":{ + "shape":"String", + "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + } + }, + "documentation":"

Metadata assigned to a DB Instance consisting of a key-value pair.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + }, + "documentation":"

A list of tags.

" + }, + "TagListMessage":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

List of tags returned by the ListTagsForResource operation.

" + } + }, + "documentation":"

" + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

The name of the VPC security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the VPC Security Group.

" + } + }, + "documentation":"

This data type is used as a response element for queries on VPC security group membership.

" + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + } + } +} diff --git a/apis/rds-2013-01-10.paginators.json b/apis/rds-2013-01-10.paginators.json new file mode 100644 index 0000000000..e70d762e00 --- /dev/null +++ b/apis/rds-2013-01-10.paginators.json @@ -0,0 +1,97 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} diff --git a/apis/rds-2013-02-12.api.json b/apis/rds-2013-02-12.api.json new file mode 100644 index 0000000000..76c71720a9 --- /dev/null +++ b/apis/rds-2013-02-12.api.json @@ -0,0 +1,2052 @@ +{ + "metadata": { + "apiVersion": "2013-02-12", + "endpointPrefix": "rds", + "serviceAbbreviation": "Amazon RDS", + "serviceFullName": "Amazon Relational Database Service", + "signatureVersion": "v4", + "xmlNamespace": "http://rds.amazonaws.com/doc/2013-02-12/", + "protocol": "query" + }, + "operations": { + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "AuthorizeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AuthorizeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CopyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members": { + "SourceDBSnapshotIdentifier": {}, + "TargetDBSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CopyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBInstanceReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SourceDBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "AvailabilityZone": {}, + "Port": { + "type": "integer" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBInstanceReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "S1d" + } + } + } + }, + "CreateDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members": { + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSecurityGroupResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CreateDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1j" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "SourceIds": { + "shape": "S5" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "CreateOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members": { + "OptionGroupName": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "OptionGroupDescription": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1p" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {} + } + } + }, + "DeleteDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "DeleteOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {} + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S28" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S28", + "locationName": "CharacterSet" + } + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "St", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBLogFiles": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "FilenameContains": {}, + "FileLastWritten": { + "type": "long" + }, + "FileSize": { + "type": "long" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBLogFilesResult", + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "type": "list", + "member": { + "locationName": "DescribeDBLogFilesDetails", + "type": "structure", + "members": { + "LogFileName": {}, + "LastWritten": { + "type": "long" + }, + "Size": { + "type": "long" + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "S1d", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2n" + }, + "Marker": {} + } + } + }, + "DescribeDBSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSecurityGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "DBSecurityGroup" + } + } + } + } + }, + "DescribeDBSnapshots": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "SnapshotType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSnapshots": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "DBSnapshot" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S11", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2n" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {} + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S6" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S6" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S6" + }, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeOptionGroupOptions": { + "input": { + "type": "structure", + "required": [ + "EngineName" + ], + "members": { + "EngineName": {}, + "MajorEngineVersion": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupOptionsResult", + "type": "structure", + "members": { + "OptionGroupOptions": { + "type": "list", + "member": { + "locationName": "OptionGroupOption", + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "MinimumRequiredMinorEngineVersion": {}, + "PortRequired": { + "type": "boolean" + }, + "DefaultPort": { + "type": "integer" + }, + "OptionsDependedOn": { + "type": "list", + "member": { + "locationName": "OptionName" + } + }, + "Persistent": { + "type": "boolean" + }, + "OptionGroupOptionSettings": { + "type": "list", + "member": { + "locationName": "OptionGroupOptionSetting", + "type": "structure", + "members": { + "SettingName": {}, + "SettingDescription": {}, + "DefaultValue": {}, + "ApplyType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeOptionGroups": { + "input": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "EngineName": {}, + "MajorEngineVersion": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupsResult", + "type": "structure", + "members": { + "OptionGroupsList": { + "type": "list", + "member": { + "shape": "S1p", + "locationName": "OptionGroup" + } + }, + "Marker": {} + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S14", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedDBInstances": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstances": { + "type": "list", + "member": { + "shape": "S3w", + "locationName": "ReservedDBInstance" + } + } + } + } + }, + "DescribeReservedDBInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstancesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedDBInstancesOffering", + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "RecurringCharges": { + "shape": "S3y" + } + }, + "wrapper": true + } + } + } + } + }, + "DownloadDBLogFilePortion": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "LogFileName" + ], + "members": { + "DBInstanceIdentifier": {}, + "LogFileName": {}, + "Marker": {}, + "NumberOfLines": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DownloadDBLogFilePortionResult", + "type": "structure", + "members": { + "LogFileData": {}, + "Marker": {}, + "AdditionalDataPending": { + "type": "boolean" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {} + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "S9" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S2n" + } + } + }, + "output": { + "shape": "S4b", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1j" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "ModifyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {}, + "OptionsToInclude": { + "type": "list", + "member": { + "locationName": "OptionConfiguration", + "type": "structure", + "required": [ + "OptionName" + ], + "members": { + "OptionName": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "Sp" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sq" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1t", + "locationName": "OptionSetting" + } + } + } + } + }, + "OptionsToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1p" + } + } + } + }, + "PromoteReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "PromoteReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "PurchaseReservedDBInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedDBInstancesOfferingId" + ], + "members": { + "ReservedDBInstancesOfferingId": {}, + "ReservedDBInstanceId": {}, + "DBInstanceCount": { + "type": "integer" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "PurchaseReservedDBInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedDBInstance": { + "shape": "S3w" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2n" + } + } + }, + "output": { + "shape": "S4b", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBInstanceFromDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RestoreDBInstanceFromDBSnapshotResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RestoreDBInstanceToPointInTime": { + "input": { + "type": "structure", + "required": [ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members": { + "SourceDBInstanceIdentifier": {}, + "TargetDBInstanceIdentifier": {}, + "RestoreTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RestoreDBInstanceToPointInTimeResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RevokeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RevokeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S5" + }, + "EventCategoriesList": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S5": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S6": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S9": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sd": { + "type": "structure", + "members": { + "OwnerId": {}, + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "VpcId": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {} + }, + "wrapper": true + }, + "Sp": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "Sq": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "St": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "shape": "Sv" + }, + "VpcSecurityGroups": { + "shape": "Sx" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S11" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {} + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "OptionGroupMembership", + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "type": "boolean" + } + }, + "wrapper": true + }, + "Sv": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "Sx": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S11": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S14" + }, + "SubnetStatus": {} + } + } + } + }, + "wrapper": true + }, + "S14": { + "type": "structure", + "members": { + "Name": {}, + "ProvisionedIopsCapable": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S1d": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S1j": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1p": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "OptionGroupDescription": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "Options": { + "type": "list", + "member": { + "locationName": "Option", + "type": "structure", + "members": { + "OptionName": {}, + "OptionDescription": {}, + "Persistent": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1t", + "locationName": "OptionSetting" + } + }, + "DBSecurityGroupMemberships": { + "shape": "Sv" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sx" + } + } + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "type": "boolean" + }, + "VpcId": {} + }, + "wrapper": true + }, + "S1t": { + "type": "structure", + "members": { + "Name": {}, + "Value": {}, + "DefaultValue": {}, + "Description": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "IsCollection": { + "type": "boolean" + } + } + }, + "S28": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S2n": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S3w": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "DBInstanceCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "State": {}, + "RecurringCharges": { + "shape": "S3y" + } + }, + "wrapper": true + }, + "S3y": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S4b": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/apis/rds-2013-02-12.full.json b/apis/rds-2013-02-12.full.json new file mode 100644 index 0000000000..8218a20085 --- /dev/null +++ b/apis/rds-2013-02-12.full.json @@ -0,0 +1,6392 @@ +{ + "metadata":{ + "apiVersion":"2013-02-12", + "endpointPrefix":"rds", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "signatureVersion":"v4", + "xmlNamespace":"http://rds.amazonaws.com/doc/2013-02-12/", + "protocol":"query" + }, + "documentation":"Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code, applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB Instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This is the Amazon RDS API Reference. It contains a comprehensive description of all Amazon RDS Query APIs and data types. Note that this API is asynchronous and some actions may require polling to determine when an action has been applied. See the parameter description to determine if a change is applied immediately or on the next instance reboot or during the maintenance window. For more information on Amazon RDS concepts and usage scenarios, see the Amazon RDS User Guide.

", + "operations":{ + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddSourceIdentifierToSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Adds a source identifier to an existing RDS event notification subscription.

" + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddTagsToResourceMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Adds metadata tags to a DB Instance. These tags can also be used with cost allocation reporting to track cost associated with a DB Instance.

" + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AuthorizeDBSecurityGroupIngressMessage", + "documentation":"

" + }, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"AuthorizationAlreadyExistsFault", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

" + }, + { + "shape":"AuthorizationQuotaExceededFault", + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB security group authorization quota has been reached.

" + } + ], + "documentation":"

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopyDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"CopyDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.

" + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Creates a new DB instance.

" + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Creates a DB Instance that acts as a Read Replica of a source DB Instance.

All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except as specified below.

The source DB Instance must have backup retention enabled.

" + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBParameterGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupQuotaExceededFault", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" + }, + { + "shape":"DBParameterGroupAlreadyExistsFault", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB parameter group with the same name exists.

" + } + ], + "documentation":"

Creates a new DB Parameter Group.

A DB Parameter Group is initially created with the default parameters for the database engine used by the DB Instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB Parameter Group, you need to associate it with your DB Instance using ModifyDBInstance. When you associate a new DB Parameter Group with a running DB Instance, you need to reboot the DB Instance for the new DB Parameter Group and associated settings to take effect.

" + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSecurityGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupAlreadyExistsFault", + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

" + }, + { + "shape":"DBSecurityGroupQuotaExceededFault", + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

" + }, + { + "shape":"DBSecurityGroupNotSupportedFault", + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group is not allowed for this action.

" + } + ], + "documentation":"

Creates a new DB Security Group. DB Security Groups control access to a DB Instance.

" + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

" + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSubnetGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupAlreadyExistsFault", + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupQuotaExceededFault", + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

" + }, + { + "shape":"DBSubnetQuotaExceededFault", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + } + ], + "documentation":"

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + { + "shape":"SubscriptionAlreadyExistFault", + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied subscription name already exists.

" + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

" + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateOptionGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateOptionGroupResult", + "wrapper":true, + "documentation":"

", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + { + "shape":"OptionGroupAlreadyExistsFault", + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group you are trying to create already exists.

" + }, + { + "shape":"OptionGroupQuotaExceededFault", + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" + } + ], + "documentation":"

Creates a new Option Group. You can create up to 20 option groups.

" + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB Snapshots of the DB instance to be deleted are not deleted.

If a final DBSnapshot is requested the status of the RDS instance will be \"deleting\" until the DBSnapshot is created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.

" + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBParameterGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.

" + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSecurityGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + } + ], + "documentation":"

Deletes a DB Security Group.

" + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Deletes a DBSnapshot.

" + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSubnetGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBSubnetGroupStateFault", + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet group cannot be deleted because it is in use.

" + }, + { + "shape":"InvalidDBSubnetStateFault", + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is not in the available state.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + } + ], + "documentation":"

Deletes a DB subnet group.

" + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"InvalidEventSubscriptionStateFault", + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

" + } + ], + "documentation":"

Deletes an RDS event notification subscription.

" + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteOptionGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + { + "shape":"InvalidOptionGroupStateFault", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + } + ], + "documentation":"

Deletes an existing Option Group.

" + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

", + "resultWrapper":"DescribeDBEngineVersionsResult" + }, + "documentation":"

Returns a list of the available DB engines.

" + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBInstancesMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBInstanceMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Returns information about provisioned RDS instances. This API supports pagination.

" + }, + "DescribeDBLogFiles":{ + "name":"DescribeDBLogFiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBLogFilesMessage", + "documentation":"

" + }, + "output":{ + "shape":"DescribeDBLogFilesResponse", + "documentation":"

The response from a call to DescribeDBLogFiles.

", + "resultWrapper":"DescribeDBLogFilesResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Returns a list of DB log files for the DB instance.

" + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBParameterGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup.

" + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Returns the detailed parameter list for a particular DBParameterGroup.

" + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSecurityGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSecurityGroupMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + } + ], + "documentation":"

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSnapshotsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSnapshotMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Returns information about DBSnapshots. This API supports pagination.

" + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSubnetGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSubnetGroupMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + } + ], + "documentation":"

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEngineDefaultParametersMessage", + "documentation":"

" + }, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "documentation":"

Returns the default engine and system parameter information for the specified database engine.

" + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventCategoriesMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventCategoriesMessage", + "documentation":"

Data returned from the DescribeEventCategories action.

", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

" + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventSubscriptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventSubscriptionsMessage", + "documentation":"

Data returned by the DescribeEventSubscriptions action.

", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + } + ], + "documentation":"

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventsMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days. Events specific to a particular DB Instance, DB Security Group, database snapshot or DB Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

" + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOptionGroupOptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OptionGroupOptionsMessage", + "documentation":"

", + "resultWrapper":"DescribeOptionGroupOptionsResult" + }, + "documentation":"

Describes all available options.

" + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOptionGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OptionGroups", + "documentation":"

List of option groups.

", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Describes the available option groups.

" + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOrderableDBInstanceOptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + }, + "documentation":"

Returns a list of orderable DB Instance options for the specified engine.

" + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedDBInstancesMessage", + "documentation":"

" + }, + "output":{ + "shape":"ReservedDBInstanceMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + { + "shape":"ReservedDBInstanceNotFoundFault", + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified reserved DB Instance not found.

" + } + ], + "documentation":"

Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.

" + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedDBInstancesOfferingsMessage", + "documentation":"

" + }, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + { + "shape":"ReservedDBInstancesOfferingNotFoundFault", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + } + ], + "documentation":"

Lists available reserved DB Instance offerings.

" + }, + "DownloadDBLogFilePortion":{ + "name":"DownloadDBLogFilePortion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DownloadDBLogFilePortionMessage", + "documentation":"

" + }, + "output":{ + "shape":"DownloadDBLogFilePortionDetails", + "documentation":"

This data type is used as a response element to DownloadDBLogFilePortion.

", + "resultWrapper":"DownloadDBLogFilePortionResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Downloads the last line of the specified log file.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListTagsForResourceMessage", + "documentation":"

" + }, + "output":{ + "shape":"TagListMessage", + "documentation":"

", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Lists all tags on a DB Instance.

" + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + { + "shape":"DBUpgradeDependencyFailureFault", + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

" + } + ], + "documentation":"

Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupNameMessage", + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + } + ], + "documentation":"

Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

" + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBSubnetGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetQuotaExceededFault", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + { + "shape":"SubnetAlreadyInUse", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is already in use in the Availability Zone.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + } + ], + "documentation":"

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + } + ], + "documentation":"

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyOptionGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyOptionGroupResult", + "wrapper":true, + "documentation":"

", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + { + "shape":"InvalidOptionGroupStateFault", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Modifies an existing Option Group.

" + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PromoteReadReplicaMessage", + "documentation":"

" + }, + "output":{ + "shape":"PromoteReadReplicaResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Promotes a Read Replica DB Instance to a standalone DB Instance.

" + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PurchaseReservedDBInstancesOfferingMessage", + "documentation":"

" + }, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + { + "shape":"ReservedDBInstancesOfferingNotFoundFault", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + }, + { + "shape":"ReservedDBInstanceAlreadyExistsFault", + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a reservation with the given identifier.

" + }, + { + "shape":"ReservedDBInstanceQuotaExceededFault", + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would exceed the user's DB Instance quota.

" + } + ], + "documentation":"

Purchases a reserved DB Instance offering.

" + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RebootDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"RebootDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed.

" + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveSourceIdentifierFromSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Removes a source identifier from an existing RDS event notification subscription.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTagsFromResourceMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Removes metadata tags from a DB Instance.

" + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ResetDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupNameMessage", + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

" + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreDBInstanceFromDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Creates a new DB Instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.

" + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreDBInstanceToPointInTimeMessage", + "documentation":"

" + }, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"PointInTimeRestoreNotEnabledFault", + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.

" + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RevokeDBSecurityGroupIngressMessage", + "documentation":"

" + }, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + } + ], + "documentation":"

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

" + } + }, + "shapes":{ + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to add a source identifier to.

" + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

" + } + }, + "documentation":"

" + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The DB Instance the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB Instance.

" + } + }, + "documentation":"

" + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

" + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

" + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB security group authorization quota has been reached.

" + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group to add authorization to.

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

The IP range to authorize.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "documentation":"

" + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the availability zone.

" + }, + "ProvisionedIopsCapable":{ + "shape":"Boolean", + "documentation":"

True indicates the availability zone is capable of provisioned IOPs.

" + } + }, + "wrapper":true, + "documentation":"

Contains Availability Zone information.

This data type is used as an element in the following data type:

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{ + "shape":"String", + "documentation":"

The name of the character set.

" + }, + "CharacterSetDescription":{ + "shape":"String", + "documentation":"

The description of the character set.

" + } + }, + "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the source DB snapshot.

Constraints:

Example: rds:mydb-2012-04-02-00-01

" + }, + "TargetDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the copied snapshot.

Constraints:

Example: my-db-snapshot

" + } + }, + "documentation":"

" + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORCL

Constraints:

SQL Server

Not applicable. Must be null.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

Example: mydbinstance

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

SQL Server

Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the DB Instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine to be used for this instance.

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

The name of master user for the client DB Instance.

MySQL

Constraints:

Type: String

Oracle

Constraints:

SQL Server

Constraints:

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The password for the master database user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".

Type: String

MySQL

Constraints: Must contain from 8 to 41 alphanumeric characters.

Oracle

Constraints: Must contain from 8 to 30 alphanumeric characters.

SQL Server

Constraints: Must contain from 8 to 128 alphanumeric characters.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC Security Groups to associate with this DB Instance.

Default: The default EC2 VPC Security Group for the DB Subnet group's VPC.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434 and 3389.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to use.

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

Type: String

SQL Server

Example: 10.50.2789.0.v1

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Indicates that the DB Instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + } + }, + "documentation":"

" + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

" + }, + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + } + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

Constraints:

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The DB Parameter Group Family name. A DB Parameter Group can be associated with one and only one DB Parameter Group Family, and can be applied only to a DB Instance running a database engine and engine version compatible with that DB Parameter Group Family.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the DB Parameter Group.

" + } + }, + "documentation":"

" + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name for the DB Security Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mysecuritygroup

" + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB Security Group.

" + } + }, + "documentation":"

" + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB Snapshot.

Constraints:

Example: my-snapshot-id

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This is the unique key that identifies a DB Instance. This parameter isn't case sensitive.

Constraints:

" + } + }, + "documentation":"

" + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB Subnet Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB Subnet Group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 Subnet IDs for the DB Subnet Group.

" + } + }, + "documentation":"

" + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the subscription.

Constraints: The name must be less than 255 characters.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

" + } + }, + "documentation":"

" + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the option group to be created.

Constraints:

Example: myOptiongroup

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Specifies the name of the engine that this option group should be associated with.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Specifies the major version of the engine that this option group should be associated with.

" + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

The description of the option group.

" + } + }, + "documentation":"

" + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DBParameterGroupFamily for the database engine.

" + }, + "DBEngineDescription":{ + "shape":"String", + "documentation":"

The description of the database engine.

" + }, + "DBEngineVersionDescription":{ + "shape":"String", + "documentation":"

The description of the database engine version.

" + }, + "DefaultCharacterSet":{ + "shape":"CharacterSet", + "documentation":"

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

" + }, + "SupportedCharacterSets":{ + "shape":"SupportedCharacterSetsList", + "documentation":"

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

" + } + }, + "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBEngineVersions":{ + "shape":"DBEngineVersionList", + "documentation":"

A list of DBEngineVersion elements.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

" + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the name of the compute and memory capacity class of the DB Instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Provides the name of the database engine to be used for this DB Instance.

" + }, + "DBInstanceStatus":{ + "shape":"String", + "documentation":"

Specifies the current state of this database.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Contains the master username for the DB Instance.

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

Specifies the connection endpoint.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

Specifies the allocated storage size specified in gigabytes.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the date and time the DB Instance was created.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" + }, + "BackupRetentionPeriod":{ + "shape":"Integer", + "documentation":"

Specifies the number of days for which automatic DB Snapshots are retained.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

Provides List of VPC security group elements that the DB Instance belongs to.

" + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupStatusList", + "documentation":"

Provides the list of DB Parameter Groups applied to this DB Instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Specifies the name of the Availability Zone the DB Instance is located in.

" + }, + "DBSubnetGroup":{ + "shape":"DBSubnetGroup", + "documentation":"

Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range (in UTC) during which system maintenance can occur.

" + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that minor version patches are applied automatically.

" + }, + "ReadReplicaSourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

" + }, + "ReadReplicaDBInstanceIdentifiers":{ + "shape":"ReadReplicaDBInstanceIdentifierList", + "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for this DB Instance.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value.

" + }, + "OptionGroupMemberships":{ + "shape":"OptionGroupMembershipList", + "documentation":"

Provides the list of option group memberships for this DB Instance.

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

If present, specifies the name of the character set that this instance is associated with.

" + }, + "SecondaryAvailabilityZone":{ + "shape":"String", + "documentation":"

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

" + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "DBInstances":{ + "shape":"DBInstanceList", + "documentation":"

A list of DBInstance instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

" + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

Provides the name of the DB Parameter Group.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides the customer-specified description for this DB Parameter Group.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

" + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB parameter group with the same name exists.

" + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of Parameter instances.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

" + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

" + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DP Parameter Group.

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

The status of parameter updates.

" + } + }, + "documentation":"

The status of the DB Parameter Group.

This data type is used as a response element in the following actions:

" + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupList", + "documentation":"

A list of DBParameterGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

" + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

Provides the AWS ID of the owner of a specific DB Security Group.

" + }, + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the DB Security Group.

" + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the DB Security Group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the VpcId of the DB Security Group.

" + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

Contains a list of EC2SecurityGroup elements.

" + }, + "IPRanges":{ + "shape":"IPRangeList", + "documentation":"

Contains a list of IPRange elements.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

" + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB Security Group.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroups", + "documentation":"

A list of DBSecurityGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

" + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group is not allowed for this action.

" + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

" + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier for the DB Snapshot.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the time (UTC) when the snapshot was taken.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Specifies the name of the database engine.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

Specifies the allocated storage size in gigabytes (GB).

" + }, + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of this DB Snapshot.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the database engine was listening on at the time of the snapshot.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the Vpc Id associated with the DB Snapshot.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

Specifies the time (UTC) when the snapshot was taken.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Provides the master username for the DB Snapshot.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Specifies the version of the database engine.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB Instance.

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

Provides the type of the DB Snapshot.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Provides the option group name for the DB Snapshot.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

" + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSnapshots":{ + "shape":"DBSnapshotList", + "documentation":"

A list of DBSnapshot instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

" + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the DB Subnet Group.

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the DB Subnet Group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the VpcId of the DB Subnet Group.

" + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

Provides the status of the DB Subnet Group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Contains a list of Subnet elements.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

" + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

" + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSubnetGroups":{ + "shape":"DBSubnetGroups", + "documentation":"

A list of DBSubnetGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

" + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

" + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

" + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier for the DB Instance to be deleted. This parameter isn't case sensitive.

Constraints:

" + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

Determines whether a final DB Snapshot is created before the DB Instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB Snapshot is created before the DB Instance is deleted.

Default: false

" + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group to delete.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DBSnapshot identifier.

Constraints: Must be the name of an existing DB Snapshot in the available state.

" + } + }, + "documentation":"

" + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the database subnet group to delete.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to delete.

" + } + }, + "documentation":"

" + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be deleted.

" + } + }, + "documentation":"

" + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The database engine to return.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The database engine version to return.

Example: 5.1.49

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of a specific DB Parameter Group family to return details for.

Constraints:

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

Indicates that only the default version of the specified engine or engine and major version combination is returned.

" + }, + "ListSupportedCharacterSets":{ + "shape":"BooleanOptional", + "documentation":"

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

" + } + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB Instance is returned. This parameter isn't case sensitive.

Constraints:

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeDBLogFilesDetails":{ + "type":"structure", + "members":{ + "LogFileName":{ + "shape":"String", + "documentation":"

The name of the log file for the specified DB instance.

" + }, + "LastWritten":{ + "shape":"Long", + "documentation":"

The date and time that the last log entry was written.

" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size, in bytes, of the log file for the specified DB instance.

" + } + }, + "documentation":"

This data type is used as a response element to DescribeDBLogFiles.

" + }, + "DescribeDBLogFilesList":{ + "type":"list", + "member":{ + "shape":"DescribeDBLogFilesDetails", + "locationName":"DescribeDBLogFilesDetails" + } + }, + "DescribeDBLogFilesMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The customer-assigned name of the DB Instance that contains the log files you want to list.

Constraints:

" + }, + "FilenameContains":{ + "shape":"String", + "documentation":"

Filters the available log files for log file names that contain the specified string.

" + }, + "FileLastWritten":{ + "shape":"Long", + "documentation":"

Filters the available log files for files written since the specified date.

" + }, + "FileSize":{ + "shape":"Long", + "documentation":"

Filters the available log files for files larger than the specified size.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBLogFilesResponse":{ + "type":"structure", + "members":{ + "DescribeDBLogFiles":{ + "shape":"DescribeDBLogFilesList", + "documentation":"

The DB log files returned.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional paging token.

" + } + }, + "documentation":"

The response from a call to DescribeDBLogFiles.

" + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB Parameter Group to return details for.

Constraints:

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB Parameter Group to return details for.

Constraints:

" + }, + "Source":{ + "shape":"String", + "documentation":"

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.

Constraints:

" + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Subnet Group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group Family.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + } + }, + "documentation":"

" + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to describe.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Constraints:

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes to retrieve events for.

Default: 60

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories that trigger notifications for a event notification subscription.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{ + "shape":"String", + "documentation":"

A required parameter. Options available for the given Engine name will be described.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

If specified, filters the results to include only options for the specified major engine version.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Filters the list of option groups to only include groups associated with a specific database engine.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

" + } + }, + "documentation":"

" + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the engine to retrieve DB Instance options for.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

" + }, + "Vpc":{ + "shape":"BooleanOptional", + "documentation":"

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

The reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "Double":{"type":"double"}, + "DownloadDBLogFilePortionDetails":{ + "type":"structure", + "members":{ + "LogFileData":{ + "shape":"String", + "documentation":"

Entries from the specified log file.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DownloadDBLogFilePortion request.

" + }, + "AdditionalDataPending":{ + "shape":"Boolean", + "documentation":"

Boolean value that if true, indicates there is more data to be downloaded.

" + } + }, + "documentation":"

This data type is used as a response element to DownloadDBLogFilePortion.

" + }, + "DownloadDBLogFilePortionMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "LogFileName" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The customer-assigned name of the DB Instance that contains the log files you want to list.

Constraints:

" + }, + "LogFileName":{ + "shape":"String", + "documentation":"

The name of the log file to be downloaded.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" + }, + "NumberOfLines":{ + "shape":"Integer", + "documentation":"

The number of lines remaining to be downloaded.

" + } + }, + "documentation":"

" + }, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the EC2 Security Group.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

Specifies the id of the EC2 Security Group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

Specifies the DNS address of the DB Instance.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the database engine is listening on.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Specifies the name of the DB Parameter Group Family which the engine default parameters apply to.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Contains a list of engine default parameters.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

Provides the identifier for the source of the event.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the source type for this event.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Provides the text of this event.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

Specifies the category for the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

Specifies the date and time of the event.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeEvents action.

" + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The source type that the returned categories belong to

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

The event categories for the specified source type

" + } + }, + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventCategories action.

" + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

A list of EventCategoriesMap data types.

" + } + }, + "documentation":"

Data returned from the DescribeEventCategories action.

" + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{ + "shape":"String", + "documentation":"

The AWS customer account associated with the RDS event notification subscription.

" + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

The RDS event notification subscription Id.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The topic ARN of the RDS event notification subscription.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + }, + "SubscriptionCreationTime":{ + "shape":"String", + "documentation":"

The time the RDS event notification subscription was created.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The source type for the RDS event notification subscription.

" + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

A list of source Ids for the RDS event notification subscription.

" + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for the RDS event notification subscription.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" + } + }, + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

A list of EventSubscriptions data types.

" + } + }, + "documentation":"

Data returned by the DescribeEventSubscriptions action.

" + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

A list of Event instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

" + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

Specifies the IP range.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet group cannot be deleted because it is in use.

" + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is not in the available state.

" + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

" + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The DB Instance with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" + } + }, + "documentation":"

" + }, + "Long":{"type":"long"}, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This value is stored as a lowercase string.

Constraints:

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The new storage capacity of the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DB Security Groups to authorize on this DB Instance. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

Constraints:

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first. See each parameter to determine when a change is applied.

Default: false

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The new password for the DB Instance master user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

" + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group to apply to this DB Instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Default: Uses existing setting

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB Instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Constraints: Cannot be specified if the DB Instance is a read replica.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

" + }, + "AllowMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Indicates that the DB Instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + }, + "NewDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The new DB Instance identifier for the DB Instance when renaming a DB Instance. This value is stored as a lowercase string.

Constraints:

" + } + }, + "documentation":"

" + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

Constraints:

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

" + } + }, + "documentation":"

" + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB Subnet Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB Subnet Group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 Subnet IDs for the DB Subnet Group.

" + } + }, + "documentation":"

" + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription.

" + } + }, + "documentation":"

" + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + }, + "OptionsToInclude":{ + "shape":"OptionConfigurationList", + "documentation":"

Options in this list are added to the Option Group or, if already present, the specified configuration is used to update the existing configuration.

" + }, + "OptionsToRemove":{ + "shape":"OptionNamesList", + "documentation":"

Options in this list are removed from the Option Group.

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the Option Group.

" + } + }, + "documentation":"

" + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

The name of the option.

" + }, + "OptionDescription":{ + "shape":"String", + "documentation":"

The description of the option.

" + }, + "Persistent":{ + "shape":"Boolean", + "documentation":"

Indicate if this option is persistent.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

If required, the port configured for this option to use.

" + }, + "OptionSettings":{ + "shape":"OptionSettingConfigurationList", + "documentation":"

The option settings for this option.

" + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

If the option requires access to a port, then this DB Security Group allows access to the port.

" + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

If the option requires access to a port, then this VPC Security Group allows access to the port.

" + } + }, + "documentation":"

Option details.

" + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

The configuration of options to include in a group.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The optional port for the option.

" + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DBSecurityGroupMemebrship name strings used for this option.

" + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of VpcSecurityGroupMemebrship name strings used for this option.

" + }, + "OptionSettings":{ + "shape":"OptionSettingsList", + "documentation":"

The option settings to include in an option group.

" + } + }, + "documentation":"

A list of all available options

" + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the option group.

" + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the option group.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Engine name that this option group can be applied to.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Indicates the major engine version associated with this option group.

" + }, + "Options":{ + "shape":"OptionsList", + "documentation":"

Indicates what options are available in the option group.

" + }, + "AllowsVpcAndNonVpcInstanceMemberships":{ + "shape":"Boolean", + "documentation":"

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value 'true' indicates the option group can be applied to both VPC and non-VPC instances.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

" + } + }, + "wrapper":true, + "documentation":"

" + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group you are trying to create already exists.

" + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group that the instance belongs to.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

" + } + }, + "documentation":"

Provides information on the option groups the DB instance is a member of.

" + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the option.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the option.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Engine name that this option can be applied to.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Indicates the major engine version that the option is available for.

" + }, + "MinimumRequiredMinorEngineVersion":{ + "shape":"String", + "documentation":"

The minimum required engine version for the option to be applied.

" + }, + "PortRequired":{ + "shape":"Boolean", + "documentation":"

Specifies whether the option requires a port.

" + }, + "DefaultPort":{ + "shape":"IntegerOptional", + "documentation":"

If the option requires a port, specifies the default port for the option.

" + }, + "OptionsDependedOn":{ + "shape":"OptionsDependedOn", + "documentation":"

List of all options that are prerequisites for this option.

" + }, + "Persistent":{ + "shape":"Boolean", + "documentation":"

Specifies whether the option is persistent in an option group.

" + }, + "OptionGroupOptionSettings":{ + "shape":"OptionGroupOptionSettingsList", + "documentation":"

Specifies the option settings that are available (and the default value) for each option in an option group.

" + } + }, + "documentation":"

Available option.

" + }, + "OptionGroupOptionSetting":{ + "type":"structure", + "members":{ + "SettingName":{ + "shape":"String", + "documentation":"

The name of the option group option.

" + }, + "SettingDescription":{ + "shape":"String", + "documentation":"

The description of the option group option.

" + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

The default value for the option group option.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

The DB engine specific parameter type for the option group option.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

Indicates the acceptable values for the option group option.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Boolean value where true indicates that this option group option can be changed from the default value.

" + } + }, + "documentation":"

Option Group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" + }, + "OptionGroupOptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOptionSetting", + "locationName":"OptionGroupOptionSetting" + } + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + }, + "documentation":"

List of available option group options.

" + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{ + "shape":"OptionGroupsList", + "documentation":"

List of option groups.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

List of option groups.

" + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionSetting":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the option that has settings that you can set.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The current value of the option setting.

" + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

The default value of the option setting.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the option setting.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

The DB engine specific parameter type.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The data type of the option setting.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

The allowed values of the option setting.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

A Boolean value that, when true, indicates the option setting can be modified from the default.

" + }, + "IsCollection":{ + "shape":"Boolean", + "documentation":"

Indicates if the option setting is part of a collection.

" + } + }, + "documentation":"

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" + }, + "OptionSettingConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The engine type of the orderable DB Instance.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version of the orderable DB Instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB Instance Class for the orderable DB Instance

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model for the orderable DB Instance.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

A list of availability zones for the orderable DB Instance.

" + }, + "MultiAZCapable":{ + "shape":"Boolean", + "documentation":"

Indicates whether this orderable DB Instance is multi-AZ capable.

" + }, + "ReadReplicaCapable":{ + "shape":"Boolean", + "documentation":"

Indicates whether this orderable DB Instance can have a read replica.

" + }, + "Vpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is a VPC orderable DB Instance.

" + } + }, + "wrapper":true, + "documentation":"

Contains a list of available options for a DB Instance

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{ + "shape":"OrderableDBInstanceOptionsList", + "documentation":"

An OrderableDBInstanceOption structure containing information about orderable options for the DB Instance.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

Specifies the name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

Specifies the value of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides a description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

Indicates the source of the parameter value.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

Specifies the engine specific parameters type.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

Specifies the valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

Specifies the valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest engine version to which the parameter can apply.

" + }, + "ApplyMethod":{ + "shape":"ApplyMethod", + "documentation":"

Indicates when to apply parameter updates.

" + } + }, + "documentation":"

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

" + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceClass for the DB Instance that will be applied or is in progress.

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

Contains the new AllocatedStorage size for the DB Instance that will be applied or is in progress.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

Contains the pending or in-progress change of the master credentials for the DB Instance.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending port for the DB Instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending number of days for which automated backups are retained.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the new Provisioned IOPS value for the DB Instance that will be applied or is being applied.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceIdentifier for the DB Instance that will be applied or is in progress.

" + } + }, + "documentation":"

This data type is used as a response element in the ModifyDBInstance action.

" + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

" + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This value is stored as a lowercase string.

Constraints:

Example: mydbinstance

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

" + } + }, + "documentation":"

" + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved DB Instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

Customer-specified identifier to track this reservation.

Example: myreservationID

" + }, + "DBInstanceCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of instances to reserve.

Default: 1

" + } + }, + "documentation":"

" + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

" + }, + "ForceFailover":{ + "shape":"BooleanOptional", + "documentation":"

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

" + } + }, + "documentation":"

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

" + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

The frequency of the recurring charge.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to remove a source identifier from.

" + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

" + } + }, + "documentation":"

" + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The DB Instance the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

The tag key (name) of the tag to be removed.

" + } + }, + "documentation":"

" + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

The unique identifier for the reservation.

" + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class for the reserved DB Instance.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The time the reservation started.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this reserved DB Instance.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this reserved DB Instance.

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved DB Instance.

" + }, + "DBInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of reserved DB Instances.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The description of the reserved DB Instance.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type of this reserved DB Instance.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Indicates if the reservation applies to Multi-AZ deployments.

" + }, + "State":{ + "shape":"String", + "documentation":"

The state of the reserved DB Instance.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved DB Instance.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

" + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a reservation with the given identifier.

" + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReservedDBInstances":{ + "shape":"ReservedDBInstanceList", + "documentation":"

A list of of reserved DB Instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

" + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified reserved DB Instance not found.

" + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would exceed the user's DB Instance quota.

" + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class for the reserved DB Instance.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this offering.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this offering.

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved DB Instance offering.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The database engine used by the offering.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Indicates if the offering applies to Multi-AZ deployments.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved DB Instance.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReservedDBInstancesOfferings":{ + "shape":"ReservedDBInstancesOfferingList", + "documentation":"

A list of reserved DB Instance offerings.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

" + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Parameter Group.

Constraints:

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

Specifies whether (true) or not (false) to reset all parameters in the DB Parameter Group to default values.

Default: true

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

" + } + }, + "documentation":"

" + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB Snapshot to restore from.

Constraints:

" + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

Constraints:

Example: my-snapshot-id

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1150-65535

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The DB Subnet Group name to use for the new instance.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB Instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The database name for the restored DB Instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Example: oracle-ee

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the amount of provisioned IOPS for the DB Instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + } + }, + "documentation":"

" + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":[ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members":{ + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the source DB Instance from which to restore.

Constraints:

" + }, + "TargetDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The name of the new database instance to be created.

Constraints:

" + }, + "RestoreTime":{ + "shape":"TStamp", + "documentation":"

The date and time to restore from.

Valid Values: Value must be a UTC time

Constraints:

Example: 2009-09-07T23:45:00Z

" + }, + "UseLatestRestorableTime":{ + "shape":"Boolean", + "documentation":"

Specifies whether (true) or not (false) the DB Instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

Default: The same DBInstanceClass as the original DB Instance.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB Instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The DB subnet group name to use for the new instance.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB Instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB Instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The database name for the restored DB Instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Example: oracle-ee

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + } + }, + "documentation":"

" + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB Security Group to revoke ingress from.

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

The id of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "documentation":"

" + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier of the subnet.

" + }, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{ + "shape":"String", + "documentation":"

Specifies the status of the subnet.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeDBSubnetGroups action.

" + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is already in use in the Availability Zone.

" + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied subscription name already exists.

" + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + }, + "Value":{ + "shape":"String", + "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + } + }, + "documentation":"

Metadata assigned to a DB Instance consisting of a key-value pair.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + }, + "documentation":"

A list of tags.

" + }, + "TagListMessage":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

List of tags returned by the ListTagsForResource operation.

" + } + }, + "documentation":"

" + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

The name of the VPC security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the VPC Security Group.

" + } + }, + "documentation":"

This data type is used as a response element for queries on VPC security group membership.

" + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + } + } +} diff --git a/apis/rds-2013-02-12.paginators.json b/apis/rds-2013-02-12.paginators.json new file mode 100644 index 0000000000..662845c12c --- /dev/null +++ b/apis/rds-2013-02-12.paginators.json @@ -0,0 +1,110 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "result_key": "LogFileData" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} diff --git a/apis/rds-2013-09-09.api.json b/apis/rds-2013-09-09.api.json new file mode 100644 index 0000000000..1daa6084b2 --- /dev/null +++ b/apis/rds-2013-09-09.api.json @@ -0,0 +1,2158 @@ +{ + "metadata": { + "apiVersion": "2013-09-09", + "endpointPrefix": "rds", + "serviceAbbreviation": "Amazon RDS", + "serviceFullName": "Amazon Relational Database Service", + "signatureVersion": "v4", + "xmlNamespace": "http://rds.amazonaws.com/doc/2013-09-09/", + "protocol": "query" + }, + "operations": { + "AddSourceIdentifierToSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AddSourceIdentifierToSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "AddTagsToResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "Tags" + ], + "members": { + "ResourceName": {}, + "Tags": { + "shape": "S9" + } + } + } + }, + "AuthorizeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AuthorizeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CopyDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members": { + "SourceDBSnapshotIdentifier": {}, + "TargetDBSnapshotIdentifier": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CopyDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "Engine": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "PreferredMaintenanceWindow": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "Port": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "CharacterSetName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBInstanceReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SourceDBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "AvailabilityZone": {}, + "Port": { + "type": "integer" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + }, + "DBSubnetGroupName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBInstanceReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "CreateDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBParameterGroupResult", + "type": "structure", + "members": { + "DBParameterGroup": { + "shape": "S1f" + } + } + } + }, + "CreateDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members": { + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSecurityGroupResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + }, + "CreateDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "CreateDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1l" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "SourceIds": { + "shape": "S5" + }, + "Enabled": { + "type": "boolean" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "CreateOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members": { + "OptionGroupName": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "OptionGroupDescription": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1r" + } + } + } + }, + "DeleteDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "SkipFinalSnapshot": { + "type": "boolean" + }, + "FinalDBSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "DeleteDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {} + } + } + }, + "DeleteDBSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {} + } + } + }, + "DeleteDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBSnapshotIdentifier" + ], + "members": { + "DBSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteDBSnapshotResult", + "type": "structure", + "members": { + "DBSnapshot": { + "shape": "Sk" + } + } + } + }, + "DeleteDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName" + ], + "members": { + "DBSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "DeleteOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {} + } + } + }, + "DescribeDBEngineVersions": { + "input": { + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "DefaultOnly": { + "type": "boolean" + }, + "ListSupportedCharacterSets": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "DescribeDBEngineVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBEngineVersions": { + "type": "list", + "member": { + "locationName": "DBEngineVersion", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBParameterGroupFamily": {}, + "DBEngineDescription": {}, + "DBEngineVersionDescription": {}, + "DefaultCharacterSet": { + "shape": "S2a" + }, + "SupportedCharacterSets": { + "type": "list", + "member": { + "shape": "S2a", + "locationName": "CharacterSet" + } + } + } + } + } + } + } + }, + "DescribeDBInstances": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "Filters": { + "shape": "S2d" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "DBInstances": { + "type": "list", + "member": { + "shape": "St", + "locationName": "DBInstance" + } + } + } + } + }, + "DescribeDBLogFiles": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "FilenameContains": {}, + "FileLastWritten": { + "type": "long" + }, + "FileSize": { + "type": "long" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBLogFilesResult", + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "type": "list", + "member": { + "locationName": "DescribeDBLogFilesDetails", + "type": "structure", + "members": { + "LogFileName": {}, + "LastWritten": { + "type": "long" + }, + "Size": { + "type": "long" + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeDBParameterGroups": { + "input": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "Filters": { + "shape": "S2d" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBParameterGroups": { + "type": "list", + "member": { + "shape": "S1f", + "locationName": "DBParameterGroup" + } + } + } + } + }, + "DescribeDBParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2s" + }, + "Marker": {} + } + } + }, + "DescribeDBSecurityGroups": { + "input": { + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Filters": { + "shape": "S2d" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSecurityGroups": { + "type": "list", + "member": { + "shape": "Sd", + "locationName": "DBSecurityGroup" + } + } + } + } + }, + "DescribeDBSnapshots": { + "input": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "SnapshotType": {}, + "Filters": { + "shape": "S2d" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSnapshots": { + "type": "list", + "member": { + "shape": "Sk", + "locationName": "DBSnapshot" + } + } + } + } + }, + "DescribeDBSubnetGroups": { + "input": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "Filters": { + "shape": "S2d" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeDBSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "DBSubnetGroups": { + "type": "list", + "member": { + "shape": "S11", + "locationName": "DBSubnetGroup" + } + } + } + } + }, + "DescribeEngineDefaultParameters": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupFamily" + ], + "members": { + "DBParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DescribeEngineDefaultParametersResult", + "type": "structure", + "members": { + "EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2s" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {} + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "EventCategories": { + "shape": "S6" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "Filters": { + "shape": "S2d" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "EventCategories": { + "shape": "S6" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S6" + }, + "Date": { + "type": "timestamp" + } + } + } + } + } + } + }, + "DescribeOptionGroupOptions": { + "input": { + "type": "structure", + "required": [ + "EngineName" + ], + "members": { + "EngineName": {}, + "MajorEngineVersion": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupOptionsResult", + "type": "structure", + "members": { + "OptionGroupOptions": { + "type": "list", + "member": { + "locationName": "OptionGroupOption", + "type": "structure", + "members": { + "Name": {}, + "Description": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "MinimumRequiredMinorEngineVersion": {}, + "PortRequired": { + "type": "boolean" + }, + "DefaultPort": { + "type": "integer" + }, + "OptionsDependedOn": { + "type": "list", + "member": { + "locationName": "OptionName" + } + }, + "Persistent": { + "type": "boolean" + }, + "Permanent": { + "type": "boolean" + }, + "OptionGroupOptionSettings": { + "type": "list", + "member": { + "locationName": "OptionGroupOptionSetting", + "type": "structure", + "members": { + "SettingName": {}, + "SettingDescription": {}, + "DefaultValue": {}, + "ApplyType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + } + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeOptionGroups": { + "input": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "Filters": { + "shape": "S2d" + }, + "Marker": {}, + "MaxRecords": { + "type": "integer" + }, + "EngineName": {}, + "MajorEngineVersion": {} + } + }, + "output": { + "resultWrapper": "DescribeOptionGroupsResult", + "type": "structure", + "members": { + "OptionGroupsList": { + "type": "list", + "member": { + "shape": "S1r", + "locationName": "OptionGroup" + } + }, + "Marker": {} + } + } + }, + "DescribeOrderableDBInstanceOptions": { + "input": { + "type": "structure", + "required": [ + "Engine" + ], + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "Vpc": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableDBInstanceOptionsResult", + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "type": "list", + "member": { + "locationName": "OrderableDBInstanceOption", + "type": "structure", + "members": { + "Engine": {}, + "EngineVersion": {}, + "DBInstanceClass": {}, + "LicenseModel": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S14", + "locationName": "AvailabilityZone" + } + }, + "MultiAZCapable": { + "type": "boolean" + }, + "ReadReplicaCapable": { + "type": "boolean" + }, + "Vpc": { + "type": "boolean" + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedDBInstances": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "Filters": { + "shape": "S2d" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstances": { + "type": "list", + "member": { + "shape": "S41", + "locationName": "ReservedDBInstance" + } + } + } + } + }, + "DescribeReservedDBInstancesOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedDBInstancesOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedDBInstancesOfferings": { + "type": "list", + "member": { + "locationName": "ReservedDBInstancesOffering", + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "RecurringCharges": { + "shape": "S43" + } + }, + "wrapper": true + } + } + } + } + }, + "DownloadDBLogFilePortion": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "LogFileName" + ], + "members": { + "DBInstanceIdentifier": {}, + "LogFileName": {}, + "Marker": {}, + "NumberOfLines": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "DownloadDBLogFilePortionResult", + "type": "structure", + "members": { + "LogFileData": {}, + "Marker": {}, + "AdditionalDataPending": { + "type": "boolean" + } + } + } + }, + "ListTagsForResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName" + ], + "members": { + "ResourceName": {} + } + }, + "output": { + "resultWrapper": "ListTagsForResourceResult", + "type": "structure", + "members": { + "TagList": { + "shape": "S9" + } + } + } + }, + "ModifyDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "AllocatedStorage": { + "type": "integer" + }, + "DBInstanceClass": {}, + "DBSecurityGroups": { + "shape": "Sp" + }, + "VpcSecurityGroupIds": { + "shape": "Sq" + }, + "ApplyImmediately": { + "type": "boolean" + }, + "MasterUserPassword": {}, + "DBParameterGroupName": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {}, + "PreferredMaintenanceWindow": {}, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AllowMajorVersionUpgrade": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "NewDBInstanceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "ModifyDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName", + "Parameters" + ], + "members": { + "DBParameterGroupName": {}, + "Parameters": { + "shape": "S2s" + } + } + }, + "output": { + "shape": "S4g", + "resultWrapper": "ModifyDBParameterGroupResult" + } + }, + "ModifyDBSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "DBSubnetGroupName", + "SubnetIds" + ], + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "SubnetIds": { + "shape": "S1l" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyDBSubnetGroupResult", + "type": "structure", + "members": { + "DBSubnetGroup": { + "shape": "S11" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "EventCategories": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "ModifyOptionGroup": { + "input": { + "type": "structure", + "required": [ + "OptionGroupName" + ], + "members": { + "OptionGroupName": {}, + "OptionsToInclude": { + "type": "list", + "member": { + "locationName": "OptionConfiguration", + "type": "structure", + "required": [ + "OptionName" + ], + "members": { + "OptionName": {}, + "Port": { + "type": "integer" + }, + "DBSecurityGroupMemberships": { + "shape": "Sp" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sq" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1v", + "locationName": "OptionSetting" + } + } + } + } + }, + "OptionsToRemove": { + "type": "list", + "member": {} + }, + "ApplyImmediately": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyOptionGroupResult", + "type": "structure", + "members": { + "OptionGroup": { + "shape": "S1r" + } + } + } + }, + "PromoteReadReplica": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "PreferredBackupWindow": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "PromoteReadReplicaResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "PurchaseReservedDBInstancesOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedDBInstancesOfferingId" + ], + "members": { + "ReservedDBInstancesOfferingId": {}, + "ReservedDBInstanceId": {}, + "DBInstanceCount": { + "type": "integer" + }, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "PurchaseReservedDBInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedDBInstance": { + "shape": "S41" + } + } + } + }, + "RebootDBInstance": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "ForceFailover": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RebootDBInstanceResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RemoveSourceIdentifierFromSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SourceIdentifier" + ], + "members": { + "SubscriptionName": {}, + "SourceIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RemoveSourceIdentifierFromSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S4" + } + } + } + }, + "RemoveTagsFromResource": { + "input": { + "type": "structure", + "required": [ + "ResourceName", + "TagKeys" + ], + "members": { + "ResourceName": {}, + "TagKeys": { + "type": "list", + "member": {} + } + } + } + }, + "ResetDBParameterGroup": { + "input": { + "type": "structure", + "required": [ + "DBParameterGroupName" + ], + "members": { + "DBParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2s" + } + } + }, + "output": { + "shape": "S4g", + "resultWrapper": "ResetDBParameterGroupResult" + } + }, + "RestoreDBInstanceFromDBSnapshot": { + "input": { + "type": "structure", + "required": [ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members": { + "DBInstanceIdentifier": {}, + "DBSnapshotIdentifier": {}, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RestoreDBInstanceFromDBSnapshotResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RestoreDBInstanceToPointInTime": { + "input": { + "type": "structure", + "required": [ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members": { + "SourceDBInstanceIdentifier": {}, + "TargetDBInstanceIdentifier": {}, + "RestoreTime": { + "type": "timestamp" + }, + "UseLatestRestorableTime": { + "type": "boolean" + }, + "DBInstanceClass": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "DBSubnetGroupName": {}, + "MultiAZ": { + "type": "boolean" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "LicenseModel": {}, + "DBName": {}, + "Engine": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "Tags": { + "shape": "S9" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RestoreDBInstanceToPointInTimeResult", + "type": "structure", + "members": { + "DBInstance": { + "shape": "St" + } + } + } + }, + "RevokeDBSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "DBSecurityGroupName" + ], + "members": { + "DBSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RevokeDBSecurityGroupIngressResult", + "type": "structure", + "members": { + "DBSecurityGroup": { + "shape": "Sd" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": {}, + "SourceType": {}, + "SourceIdsList": { + "shape": "S5" + }, + "EventCategoriesList": { + "shape": "S6" + }, + "Enabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S5": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S6": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S9": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sd": { + "type": "structure", + "members": { + "OwnerId": {}, + "DBSecurityGroupName": {}, + "DBSecurityGroupDescription": {}, + "VpcId": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupId": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + } + }, + "wrapper": true + }, + "Sk": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": {}, + "DBInstanceIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Engine": {}, + "AllocatedStorage": { + "type": "integer" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "VpcId": {}, + "InstanceCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "EngineVersion": {}, + "LicenseModel": {}, + "SnapshotType": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupName": {}, + "PercentProgress": { + "type": "integer" + }, + "SourceRegion": {} + }, + "wrapper": true + }, + "Sp": { + "type": "list", + "member": { + "locationName": "DBSecurityGroupName" + } + }, + "Sq": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "St": { + "type": "structure", + "members": { + "DBInstanceIdentifier": {}, + "DBInstanceClass": {}, + "Engine": {}, + "DBInstanceStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "AllocatedStorage": { + "type": "integer" + }, + "InstanceCreateTime": { + "type": "timestamp" + }, + "PreferredBackupWindow": {}, + "BackupRetentionPeriod": { + "type": "integer" + }, + "DBSecurityGroups": { + "shape": "Sv" + }, + "VpcSecurityGroups": { + "shape": "Sx" + }, + "DBParameterGroups": { + "type": "list", + "member": { + "locationName": "DBParameterGroup", + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "AvailabilityZone": {}, + "DBSubnetGroup": { + "shape": "S11" + }, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": {}, + "AllocatedStorage": { + "type": "integer" + }, + "MasterUserPassword": {}, + "Port": { + "type": "integer" + }, + "BackupRetentionPeriod": { + "type": "integer" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "Iops": { + "type": "integer" + }, + "DBInstanceIdentifier": {} + } + }, + "LatestRestorableTime": { + "type": "timestamp" + }, + "MultiAZ": { + "type": "boolean" + }, + "EngineVersion": {}, + "AutoMinorVersionUpgrade": { + "type": "boolean" + }, + "ReadReplicaSourceDBInstanceIdentifier": {}, + "ReadReplicaDBInstanceIdentifiers": { + "type": "list", + "member": { + "locationName": "ReadReplicaDBInstanceIdentifier" + } + }, + "LicenseModel": {}, + "Iops": { + "type": "integer" + }, + "OptionGroupMemberships": { + "type": "list", + "member": { + "locationName": "OptionGroupMembership", + "type": "structure", + "members": { + "OptionGroupName": {}, + "Status": {} + } + } + }, + "CharacterSetName": {}, + "SecondaryAvailabilityZone": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "StatusInfos": { + "type": "list", + "member": { + "locationName": "DBInstanceStatusInfo", + "type": "structure", + "members": { + "StatusType": {}, + "Normal": { + "type": "boolean" + }, + "Status": {}, + "Message": {} + } + } + } + }, + "wrapper": true + }, + "Sv": { + "type": "list", + "member": { + "locationName": "DBSecurityGroup", + "type": "structure", + "members": { + "DBSecurityGroupName": {}, + "Status": {} + } + } + }, + "Sx": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupMembership", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "S11": { + "type": "structure", + "members": { + "DBSubnetGroupName": {}, + "DBSubnetGroupDescription": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S14" + }, + "SubnetStatus": {} + } + } + } + }, + "wrapper": true + }, + "S14": { + "type": "structure", + "members": { + "Name": {}, + "ProvisionedIopsCapable": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S1f": { + "type": "structure", + "members": { + "DBParameterGroupName": {}, + "DBParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S1l": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1r": { + "type": "structure", + "members": { + "OptionGroupName": {}, + "OptionGroupDescription": {}, + "EngineName": {}, + "MajorEngineVersion": {}, + "Options": { + "type": "list", + "member": { + "locationName": "Option", + "type": "structure", + "members": { + "OptionName": {}, + "OptionDescription": {}, + "Persistent": { + "type": "boolean" + }, + "Permanent": { + "type": "boolean" + }, + "Port": { + "type": "integer" + }, + "OptionSettings": { + "type": "list", + "member": { + "shape": "S1v", + "locationName": "OptionSetting" + } + }, + "DBSecurityGroupMemberships": { + "shape": "Sv" + }, + "VpcSecurityGroupMemberships": { + "shape": "Sx" + } + } + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "type": "boolean" + }, + "VpcId": {} + }, + "wrapper": true + }, + "S1v": { + "type": "structure", + "members": { + "Name": {}, + "Value": {}, + "DefaultValue": {}, + "Description": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "IsCollection": { + "type": "boolean" + } + } + }, + "S2a": { + "type": "structure", + "members": { + "CharacterSetName": {}, + "CharacterSetDescription": {} + } + }, + "S2d": { + "type": "list", + "member": { + "locationName": "Filter", + "type": "structure", + "required": [ + "FilterName", + "FilterValue" + ], + "members": { + "FilterName": {}, + "FilterValue": { + "type": "list", + "member": { + "locationName": "Value" + } + } + } + } + }, + "S2s": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "ApplyType": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {}, + "ApplyMethod": {} + } + } + }, + "S41": { + "type": "structure", + "members": { + "ReservedDBInstanceId": {}, + "ReservedDBInstancesOfferingId": {}, + "DBInstanceClass": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "DBInstanceCount": { + "type": "integer" + }, + "ProductDescription": {}, + "OfferingType": {}, + "MultiAZ": { + "type": "boolean" + }, + "State": {}, + "RecurringCharges": { + "shape": "S43" + } + }, + "wrapper": true + }, + "S43": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S4g": { + "type": "structure", + "members": { + "DBParameterGroupName": {} + } + } + } +} \ No newline at end of file diff --git a/apis/rds-2013-09-09.full.json b/apis/rds-2013-09-09.full.json new file mode 100644 index 0000000000..5313455c62 --- /dev/null +++ b/apis/rds-2013-09-09.full.json @@ -0,0 +1,6564 @@ +{ + "metadata":{ + "apiVersion":"2013-09-09", + "endpointPrefix":"rds", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "signatureVersion":"v4", + "xmlNamespace":"http://rds.amazonaws.com/doc/2013-09-09/", + "protocol":"query" + }, + "documentation":"Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code, applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.

", + "operations":{ + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddSourceIdentifierToSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Adds a source identifier to an existing RDS event notification subscription.

" + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddTagsToResourceMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

" + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AuthorizeDBSecurityGroupIngressMessage", + "documentation":"

" + }, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"AuthorizationAlreadyExistsFault", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

" + }, + { + "shape":"AuthorizationQuotaExceededFault", + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB security group authorization quota has been reached.

" + } + ], + "documentation":"

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopyDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"CopyDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.

" + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Creates a new DB instance.

" + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + { + "shape":"DBSubnetGroupNotAllowedFault", + "error":{ + "code":"DBSubnetGroupNotAllowedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.

" + }, + { + "shape":"InvalidDBSubnetGroupFault", + "error":{ + "code":"InvalidDBSubnetGroupFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.

" + } + ], + "documentation":"

Creates a DB instance that acts as a read replica of a source DB instance.

All read replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.

The source DB instance must have backup retention enabled.

" + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBParameterGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupQuotaExceededFault", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" + }, + { + "shape":"DBParameterGroupAlreadyExistsFault", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB parameter group with the same name exists.

" + } + ], + "documentation":"

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB Instance for the new DB parameter group and associated settings to take effect.

" + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSecurityGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupAlreadyExistsFault", + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

" + }, + { + "shape":"DBSecurityGroupQuotaExceededFault", + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

" + }, + { + "shape":"DBSecurityGroupNotSupportedFault", + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group is not allowed for this action.

" + } + ], + "documentation":"

Creates a new DB security group. DB security groups control access to a DB instance.

" + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

" + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSubnetGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupAlreadyExistsFault", + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupQuotaExceededFault", + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

" + }, + { + "shape":"DBSubnetQuotaExceededFault", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + } + ], + "documentation":"

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + { + "shape":"SubscriptionAlreadyExistFault", + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied subscription name already exists.

" + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

" + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateOptionGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateOptionGroupResult", + "wrapper":true, + "documentation":"

", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + { + "shape":"OptionGroupAlreadyExistsFault", + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group you are trying to create already exists.

" + }, + { + "shape":"OptionGroupQuotaExceededFault", + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" + } + ], + "documentation":"

Creates a new option group. You can create up to 20 option groups.

" + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + } + ], + "documentation":"

The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

" + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBParameterGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.

" + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSecurityGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + } + ], + "documentation":"

Deletes a DB security group.

" + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

" + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSubnetGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidDBSubnetGroupStateFault", + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet group cannot be deleted because it is in use.

" + }, + { + "shape":"InvalidDBSubnetStateFault", + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is not in the available state.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + } + ], + "documentation":"

Deletes a DB subnet group.

" + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"InvalidEventSubscriptionStateFault", + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

" + } + ], + "documentation":"

Deletes an RDS event notification subscription.

" + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteOptionGroupMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + { + "shape":"InvalidOptionGroupStateFault", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + } + ], + "documentation":"

Deletes an existing option group.

" + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

", + "resultWrapper":"DescribeDBEngineVersionsResult" + }, + "documentation":"

Returns a list of the available DB engines.

" + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBInstancesMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBInstanceMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Returns information about provisioned RDS instances. This API supports pagination.

" + }, + "DescribeDBLogFiles":{ + "name":"DescribeDBLogFiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBLogFilesMessage", + "documentation":"

" + }, + "output":{ + "shape":"DescribeDBLogFilesResponse", + "documentation":"

The response from a call to DescribeDBLogFiles.

", + "resultWrapper":"DescribeDBLogFilesResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Returns a list of DB log files for the DB instance.

" + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBParameterGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

" + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Returns the detailed parameter list for a particular DB parameter group.

" + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSecurityGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSecurityGroupMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + } + ], + "documentation":"

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

" + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSnapshotsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSnapshotMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Returns information about DB snapshots. This API supports pagination.

" + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSubnetGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBSubnetGroupMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + } + ], + "documentation":"

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEngineDefaultParametersMessage", + "documentation":"

" + }, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "documentation":"

Returns the default engine and system parameter information for the specified database engine.

" + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventCategoriesMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventCategoriesMessage", + "documentation":"

Data returned from the DescribeEventCategories action.

", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

" + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventSubscriptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventSubscriptionsMessage", + "documentation":"

Data returned by the DescribeEventSubscriptions action.

", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + } + ], + "documentation":"

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventsMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

" + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOptionGroupOptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OptionGroupOptionsMessage", + "documentation":"

", + "resultWrapper":"DescribeOptionGroupOptionsResult" + }, + "documentation":"

Describes all available options.

" + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOptionGroupsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OptionGroups", + "documentation":"

List of option groups.

", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Describes the available option groups.

" + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOrderableDBInstanceOptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + }, + "documentation":"

Returns a list of orderable DB instance options for the specified engine.

" + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedDBInstancesMessage", + "documentation":"

" + }, + "output":{ + "shape":"ReservedDBInstanceMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + { + "shape":"ReservedDBInstanceNotFoundFault", + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified reserved DB Instance not found.

" + } + ], + "documentation":"

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

" + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedDBInstancesOfferingsMessage", + "documentation":"

" + }, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + { + "shape":"ReservedDBInstancesOfferingNotFoundFault", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + } + ], + "documentation":"

Lists available reserved DB instance offerings.

" + }, + "DownloadDBLogFilePortion":{ + "name":"DownloadDBLogFilePortion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DownloadDBLogFilePortionMessage", + "documentation":"

" + }, + "output":{ + "shape":"DownloadDBLogFilePortionDetails", + "documentation":"

This data type is used as a response element to DownloadDBLogFilePortion.

", + "resultWrapper":"DownloadDBLogFilePortionResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Downloads the last line of the specified log file.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListTagsForResourceMessage", + "documentation":"

" + }, + "output":{ + "shape":"TagListMessage", + "documentation":"

", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

" + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + { + "shape":"DBUpgradeDependencyFailureFault", + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

" + } + ], + "documentation":"

Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupNameMessage", + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + } + ], + "documentation":"

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

" + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBSubnetGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetQuotaExceededFault", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + { + "shape":"SubnetAlreadyInUse", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is already in use in the Availability Zone.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + } + ], + "documentation":"

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + } + ], + "documentation":"

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyOptionGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyOptionGroupResult", + "wrapper":true, + "documentation":"

", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + { + "shape":"InvalidOptionGroupStateFault", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Modifies an existing option group.

" + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PromoteReadReplicaMessage", + "documentation":"

" + }, + "output":{ + "shape":"PromoteReadReplicaResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Promotes a read replica DB instance to a standalone DB instance.

" + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PurchaseReservedDBInstancesOfferingMessage", + "documentation":"

" + }, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + { + "shape":"ReservedDBInstancesOfferingNotFoundFault", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + }, + { + "shape":"ReservedDBInstanceAlreadyExistsFault", + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a reservation with the given identifier.

" + }, + { + "shape":"ReservedDBInstanceQuotaExceededFault", + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would exceed the user's DB Instance quota.

" + } + ], + "documentation":"

Purchases a reserved DB instance offering.

" + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RebootDBInstanceMessage", + "documentation":"

" + }, + "output":{ + "shape":"RebootDBInstanceResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + } + ], + "documentation":"

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

" + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveSourceIdentifierFromSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + } + ], + "documentation":"

Removes a source identifier from an existing RDS event notification subscription.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTagsFromResourceMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + } + ], + "documentation":"

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

" + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ResetDBParameterGroupMessage", + "documentation":"

" + }, + "output":{ + "shape":"DBParameterGroupNameMessage", + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + } + ], + "documentation":"

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

" + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreDBInstanceFromDBSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.

" + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreDBInstanceToPointInTimeMessage", + "documentation":"

" + }, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + { + "shape":"PointInTimeRestoreNotEnabledFault", + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

" + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + } + ], + "documentation":"

Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.

" + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RevokeDBSecurityGroupIngressMessage", + "documentation":"

" + }, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

" + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + } + ], + "documentation":"

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

" + } + }, + "shapes":{ + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to add a source identifier to.

" + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

" + } + }, + "documentation":"

" + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the Amazon RDS resource.

" + } + }, + "documentation":"

" + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

" + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

" + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB security group authorization quota has been reached.

" + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB security group to add authorization to.

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

The IP range to authorize.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "documentation":"

" + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the availability zone.

" + }, + "ProvisionedIopsCapable":{ + "shape":"Boolean", + "documentation":"

True indicates the availability zone is capable of provisioned IOPs.

" + } + }, + "wrapper":true, + "documentation":"

Contains Availability Zone information.

This data type is used as an element in the following data type:

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{ + "shape":"String", + "documentation":"

The name of the character set.

" + }, + "CharacterSetDescription":{ + "shape":"String", + "documentation":"

The description of the character set.

" + } + }, + "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the source DB snapshot.

Constraints:

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

" + }, + "TargetDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the copied snapshot.

Constraints:

Example: my-db-snapshot

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

Type: String

Oracle

The Oracle System ID (SID) of the created DB instance.

Default: ORCL

Constraints:

SQL Server

Not applicable. Must be null.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

Example: mydbinstance

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

SQL Server

Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine to be used for this instance.

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

The name of master user for the client DB instance.

MySQL

Constraints:

Type: String

Oracle

Constraints:

SQL Server

Constraints:

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Type: String

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

SQL Server

Constraints: Must contain from 8 to 128 characters.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434 and 3389.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to use.

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

Type: String

SQL Server

Example: 10.50.2789.0.v1

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

Default: true

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier of the read replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

" + }, + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the read replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Amazon EC2 Availability Zone that the read replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor engine upgrades will be applied automatically to the read replica during the maintenance window.

Default: Inherits from the source DB instance

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + }, + "Tags":{"shape":"TagList"}, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

A DB Subnet Group to associate with this DB Instance in case of a cross region read replica.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

Constraints: All the cross region read replicas that share the source instance should lie within the same VPC.

" + } + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

Constraints:

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the DB parameter group.

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name for the DB security group. This value is stored as a lowercase string.

Constraints:

Example: mysecuritygroup

" + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB security group.

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB snapshot.

Constraints:

Example: my-snapshot-id

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This is the unique key that identifies a DB instance. This parameter isn't case sensitive.

Constraints:

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 Subnet IDs for the DB subnet group.

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the subscription.

Constraints: The name must be less than 255 characters.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the option group to be created.

Constraints:

Example: myoptiongroup

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Specifies the name of the engine that this option group should be associated with.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Specifies the major version of the engine that this option group should be associated with.

" + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

The description of the option group.

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB parameter group family for the database engine.

" + }, + "DBEngineDescription":{ + "shape":"String", + "documentation":"

The description of the database engine.

" + }, + "DBEngineVersionDescription":{ + "shape":"String", + "documentation":"

The description of the database engine version.

" + }, + "DefaultCharacterSet":{ + "shape":"CharacterSet", + "documentation":"

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

" + }, + "SupportedCharacterSets":{ + "shape":"SupportedCharacterSetsList", + "documentation":"

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

" + } + }, + "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBEngineVersions":{ + "shape":"DBEngineVersionList", + "documentation":"

A list of DBEngineVersion elements.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

" + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains a user-supplied database identifier. This is the unique key that identifies a DB instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the name of the compute and memory capacity class of the DB instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Provides the name of the database engine to be used for this DB instance.

" + }, + "DBInstanceStatus":{ + "shape":"String", + "documentation":"

Specifies the current state of this database.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Contains the master username for the DB instance.

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

Specifies the connection endpoint.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

Specifies the allocated storage size specified in gigabytes.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the date and time the DB instance was created.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" + }, + "BackupRetentionPeriod":{ + "shape":"Integer", + "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

Provides List of VPC security group elements that the DB instance belongs to.

" + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupStatusList", + "documentation":"

Provides the list of DB parameter groups applied to this DB instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Specifies the name of the Availability Zone the DB instance is located in.

" + }, + "DBSubnetGroup":{ + "shape":"DBSubnetGroup", + "documentation":"

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range (in UTC) during which system maintenance can occur.

" + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that minor version patches are applied automatically.

" + }, + "ReadReplicaSourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the identifier of the source DB instance if this DB instance is a read replica.

" + }, + "ReadReplicaDBInstanceIdentifiers":{ + "shape":"ReadReplicaDBInstanceIdentifierList", + "documentation":"

Contains one or more identifiers of the read replicas associated with this DB instance.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for this DB instance.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value.

" + }, + "OptionGroupMemberships":{ + "shape":"OptionGroupMembershipList", + "documentation":"

Provides the list of option group memberships for this DB instance.

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

If present, specifies the name of the character set that this instance is associated with.

" + }, + "SecondaryAvailabilityZone":{ + "shape":"String", + "documentation":"

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + }, + "StatusInfos":{ + "shape":"DBInstanceStatusInfoList", + "documentation":"

The status of a read replica. If the instance is not a read replica, this will be blank.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

" + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a DB instance with the given identifier.

" + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "DBInstances":{ + "shape":"DBInstanceList", + "documentation":"

A list of DBInstance instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

" + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" + }, + "DBInstanceStatusInfo":{ + "type":"structure", + "members":{ + "StatusType":{ + "shape":"String", + "documentation":"

This value is currently \"read replication.\"

" + }, + "Normal":{ + "shape":"Boolean", + "documentation":"

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

" + } + }, + "documentation":"

Provides a list of status information for a DB instance.

" + }, + "DBInstanceStatusInfoList":{ + "type":"list", + "member":{ + "shape":"DBInstanceStatusInfo", + "locationName":"DBInstanceStatusInfo" + } + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

Provides the name of the DB parameter group.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Provides the name of the DB parameter group family that this DB parameter group is compatible with.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides the customer-specified description for this DB parameter group.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

" + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB parameter group with the same name exists.

" + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of Parameter values.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

" + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

" + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DP parameter group.

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

The status of parameter updates.

" + } + }, + "documentation":"

The status of the DB parameter group.

This data type is used as a response element in the following actions:

" + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupList", + "documentation":"

A list of DBParameterGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

" + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

Provides the AWS ID of the owner of a specific DB security group.

" + }, + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the DB security group.

" + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the DB security group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the VpcId of the DB security group.

" + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

Contains a list of EC2SecurityGroup elements.

" + }, + "IPRanges":{ + "shape":"IPRangeList", + "documentation":"

Contains a list of IPRange elements.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

" + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB security group.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroups", + "documentation":"

A list of DBSecurityGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

" + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A DB security group is not allowed for this action.

" + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

" + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier for the DB snapshot.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the time (UTC) when the snapshot was taken.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Specifies the name of the database engine.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

Specifies the allocated storage size in gigabytes (GB).

" + }, + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of this DB snapshot.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the database engine was listening on at the time of the snapshot.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the Vpc Id associated with the DB snapshot.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

Specifies the time (UTC) when the snapshot was taken.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Provides the master username for the DB snapshot.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Specifies the version of the database engine.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB instance.

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

Provides the type of the DB snapshot.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Provides the option group name for the DB snapshot.

" + }, + "PercentProgress":{ + "shape":"Integer", + "documentation":"

The percentage of the estimated data that has been transferred.

" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The region that the DB snapshot was created in or copied from.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

" + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSnapshots":{ + "shape":"DBSnapshotList", + "documentation":"

A list of DBSnapshot instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

" + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the DB subnet group.

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the DB subnet group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the VpcId of the DB subnet group.

" + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

Provides the status of the DB subnet group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Contains a list of Subnet elements.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

" + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

" + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.

" + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSubnetGroups":{ + "shape":"DBSubnetGroups", + "documentation":"

A list of DBSubnetGroup instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

" + }, + "DBSubnetGroupNotAllowedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotAllowedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.

" + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

" + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

" + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.

Constraints:

" + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Specify true when deleting a read replica.

Default: false

" + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB security group to delete.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DBSnapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

" + } + }, + "documentation":"

" + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the database subnet group to delete.

Constraints:

" + } + }, + "documentation":"

" + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to delete.

" + } + }, + "documentation":"

" + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be deleted.

" + } + }, + "documentation":"

" + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The database engine to return.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The database engine version to return.

Example: 5.1.49

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of a specific DB parameter group family to return details for.

Constraints:

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

Indicates that only the default version of the specified engine or engine and major version combination is returned.

" + }, + "ListSupportedCharacterSets":{ + "shape":"BooleanOptional", + "documentation":"

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

" + } + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.

Constraints:

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeDBLogFilesDetails":{ + "type":"structure", + "members":{ + "LogFileName":{ + "shape":"String", + "documentation":"

The name of the log file for the specified DB instance.

" + }, + "LastWritten":{ + "shape":"Long", + "documentation":"

A POSIX timestamp when the last log entry was written.

" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size, in bytes, of the log file for the specified DB instance.

" + } + }, + "documentation":"

This data type is used as a response element to DescribeDBLogFiles.

" + }, + "DescribeDBLogFilesList":{ + "type":"list", + "member":{ + "shape":"DescribeDBLogFilesDetails", + "locationName":"DescribeDBLogFilesDetails" + } + }, + "DescribeDBLogFilesMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

" + }, + "FilenameContains":{ + "shape":"String", + "documentation":"

Filters the available log files for log file names that contain the specified string.

" + }, + "FileLastWritten":{ + "shape":"Long", + "documentation":"

Filters the available log files for files written since the specified date, in POSIX timestamp format.

" + }, + "FileSize":{ + "shape":"Long", + "documentation":"

Filters the available log files for files larger than the specified size.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBLogFilesResponse":{ + "type":"structure", + "members":{ + "DescribeDBLogFiles":{ + "shape":"DescribeDBLogFilesList", + "documentation":"

The DB log files returned.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional paging token.

" + } + }, + "documentation":"

The response from a call to DescribeDBLogFiles.

" + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB parameter group to return details for.

Constraints:

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB parameter group to return details for.

Constraints:

" + }, + "Source":{ + "shape":"String", + "documentation":"

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB security group to return details for.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case sensitive.

Constraints:

" + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\" If not specified, the returned results will include all snapshots types.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB subnet group to return details for.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB parameter group family.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + } + }, + "documentation":"

" + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to describe.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Constraints:

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes to retrieve events for.

Default: 60

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories that trigger notifications for a event notification subscription.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{ + "shape":"String", + "documentation":"

A required parameter. Options available for the given Engine name will be described.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

If specified, filters the results to include only options for the specified major engine version.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Filters the list of option groups to only include groups associated with a specific database engine.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

" + } + }, + "documentation":"

" + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the engine to retrieve DB instance options for.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

" + }, + "Vpc":{ + "shape":"BooleanOptional", + "documentation":"

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

" + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "Double":{"type":"double"}, + "DownloadDBLogFilePortionDetails":{ + "type":"structure", + "members":{ + "LogFileData":{ + "shape":"String", + "documentation":"

Entries from the specified log file.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DownloadDBLogFilePortion request.

" + }, + "AdditionalDataPending":{ + "shape":"Boolean", + "documentation":"

Boolean value that if true, indicates there is more data to be downloaded.

" + } + }, + "documentation":"

This data type is used as a response element to DownloadDBLogFilePortion.

" + }, + "DownloadDBLogFilePortionMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "LogFileName" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

" + }, + "LogFileName":{ + "shape":"String", + "documentation":"

The name of the log file to be downloaded.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" + }, + "NumberOfLines":{ + "shape":"Integer", + "documentation":"

The number of lines remaining to be downloaded.

" + } + }, + "documentation":"

" + }, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the EC2 security group.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

Specifies the id of the EC2 security group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

Specifies the DNS address of the DB instance.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the database engine is listening on.

" + } + }, + "documentation":"

This data type is used as a response element in the following actions:

" + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Specifies the name of the DB parameter group family which the engine default parameters apply to.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Contains a list of engine default parameters.

" + } + }, + "wrapper":true, + "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

Provides the identifier for the source of the event.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the source type for this event.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Provides the text of this event.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

Specifies the category for the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

Specifies the date and time of the event.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeEvents action.

" + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The source type that the returned categories belong to

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

The event categories for the specified source type

" + } + }, + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventCategories action.

" + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

A list of EventCategoriesMap data types.

" + } + }, + "documentation":"

Data returned from the DescribeEventCategories action.

" + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{ + "shape":"String", + "documentation":"

The AWS customer account associated with the RDS event notification subscription.

" + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

The RDS event notification subscription Id.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The topic ARN of the RDS event notification subscription.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + }, + "SubscriptionCreationTime":{ + "shape":"String", + "documentation":"

The time the RDS event notification subscription was created.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The source type for the RDS event notification subscription.

" + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

A list of source Ids for the RDS event notification subscription.

" + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for the RDS event notification subscription.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" + } + }, + "wrapper":true, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You have reached the maximum number of event subscriptions.

" + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

A list of EventSubscriptions data types.

" + } + }, + "documentation":"

Data returned by the DescribeEventSubscriptions action.

" + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

A list of Event instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

" + }, + "Filter":{ + "type":"structure", + "required":[ + "FilterName", + "FilterValue" + ], + "members":{ + "FilterName":{ + "shape":"String", + "documentation":"

This parameter is not currently supported.

" + }, + "FilterValue":{ + "shape":"FilterValueList", + "documentation":"

This parameter is not currently supported.

" + } + } + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

Specifies the IP range.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified DB instance is not in the available state.

" + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB parameter group cannot be deleted because it is in use.

" + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB security group does not allow deletion.

" + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the DB snapshot does not allow deletion.

" + }, + "InvalidDBSubnetGroupFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.

" + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet group cannot be deleted because it is in use.

" + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is not in the available state.

" + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

" + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group is not in the available state.

" + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" + } + }, + "documentation":"

" + }, + "Long":{"type":"long"}, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The new storage capacity of the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DB security groups to authorize on this DB instance. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Constraints:

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is passed as false, changes to the DB instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first. See each parameter to determine when a change is applied.

Default: false

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

" + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group to apply to this DB instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Default: Uses existing setting

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Constraints: Cannot be specified if the DB instance is a read replica.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

Example: 5.1.42

" + }, + "AllowMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + }, + "NewDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The new DB instance identifier for the DB instance when renaming a DB Instance. This value is stored as a lowercase string.

Constraints:

" + } + }, + "documentation":"

" + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

Constraints:

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

" + } + }, + "documentation":"

" + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 subnet IDs for the DB subnet group.

" + } + }, + "documentation":"

" + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription.

" + } + }, + "documentation":"

" + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + }, + "OptionsToInclude":{ + "shape":"OptionConfigurationList", + "documentation":"

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

" + }, + "OptionsToRemove":{ + "shape":"OptionNamesList", + "documentation":"

Options in this list are removed from the option group.

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

" + } + }, + "documentation":"

" + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

The name of the option.

" + }, + "OptionDescription":{ + "shape":"String", + "documentation":"

The description of the option.

" + }, + "Persistent":{ + "shape":"Boolean", + "documentation":"

Indicate if this option is persistent.

" + }, + "Permanent":{ + "shape":"Boolean", + "documentation":"

Indicate if this option is permanent.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

If required, the port configured for this option to use.

" + }, + "OptionSettings":{ + "shape":"OptionSettingConfigurationList", + "documentation":"

The option settings for this option.

" + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

If the option requires access to a port, then this DB security group allows access to the port.

" + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

If the option requires access to a port, then this VPC security group allows access to the port.

" + } + }, + "documentation":"

Option details.

" + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

The configuration of options to include in a group.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The optional port for the option.

" + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DBSecurityGroupMemebrship name strings used for this option.

" + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of VpcSecurityGroupMemebrship name strings used for this option.

" + }, + "OptionSettings":{ + "shape":"OptionSettingsList", + "documentation":"

The option settings to include in an option group.

" + } + }, + "documentation":"

A list of all available options

" + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the option group.

" + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the option group.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Engine name that this option group can be applied to.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Indicates the major engine version associated with this option group.

" + }, + "Options":{ + "shape":"OptionsList", + "documentation":"

Indicates what options are available in the option group.

" + }, + "AllowsVpcAndNonVpcInstanceMemberships":{ + "shape":"Boolean", + "documentation":"

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value 'true' indicates the option group can be applied to both VPC and non-VPC instances.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

" + } + }, + "wrapper":true, + "documentation":"

" + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The option group you are trying to create already exists.

" + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group that the instance belongs to.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

" + } + }, + "documentation":"

Provides information on the option groups the DB instance is a member of.

" + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified option group could not be found.

" + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the option.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the option.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

Engine name that this option can be applied to.

" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

Indicates the major engine version that the option is available for.

" + }, + "MinimumRequiredMinorEngineVersion":{ + "shape":"String", + "documentation":"

The minimum required engine version for the option to be applied.

" + }, + "PortRequired":{ + "shape":"Boolean", + "documentation":"

Specifies whether the option requires a port.

" + }, + "DefaultPort":{ + "shape":"IntegerOptional", + "documentation":"

If the option requires a port, specifies the default port for the option.

" + }, + "OptionsDependedOn":{ + "shape":"OptionsDependedOn", + "documentation":"

List of all options that are prerequisites for this option.

" + }, + "Persistent":{ + "shape":"Boolean", + "documentation":"

A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.

" + }, + "Permanent":{ + "shape":"Boolean", + "documentation":"

A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.

" + }, + "OptionGroupOptionSettings":{ + "shape":"OptionGroupOptionSettingsList", + "documentation":"

Specifies the option settings that are available (and the default value) for each option in an option group.

" + } + }, + "documentation":"

Available option.

" + }, + "OptionGroupOptionSetting":{ + "type":"structure", + "members":{ + "SettingName":{ + "shape":"String", + "documentation":"

The name of the option group option.

" + }, + "SettingDescription":{ + "shape":"String", + "documentation":"

The description of the option group option.

" + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

The default value for the option group option.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

The DB engine specific parameter type for the option group option.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

Indicates the acceptable values for the option group option.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Boolean value where true indicates that this option group option can be changed from the default value.

" + } + }, + "documentation":"

option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" + }, + "OptionGroupOptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOptionSetting", + "locationName":"OptionGroupOptionSetting" + } + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + }, + "documentation":"

List of available option group options.

" + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{ + "shape":"OptionGroupsList", + "documentation":"

List of option groups.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

List of option groups.

" + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionSetting":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the option that has settings that you can set.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The current value of the option setting.

" + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

The default value of the option setting.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the option setting.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

The DB engine specific parameter type.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The data type of the option setting.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

The allowed values of the option setting.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

A Boolean value that, when true, indicates the option setting can be modified from the default.

" + }, + "IsCollection":{ + "shape":"Boolean", + "documentation":"

Indicates if the option setting is part of a collection.

" + } + }, + "documentation":"

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" + }, + "OptionSettingConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The engine type of the orderable DB instance.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version of the orderable DB instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance Class for the orderable DB instance

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model for the orderable DB instance.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

A list of availability zones for the orderable DB instance.

" + }, + "MultiAZCapable":{ + "shape":"Boolean", + "documentation":"

Indicates whether this orderable DB instance is multi-AZ capable.

" + }, + "ReadReplicaCapable":{ + "shape":"Boolean", + "documentation":"

Indicates whether this orderable DB instance can have a read replica.

" + }, + "Vpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is a VPC orderable DB instance.

" + } + }, + "wrapper":true, + "documentation":"

Contains a list of available options for a DB instance

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{ + "shape":"OrderableDBInstanceOptionsList", + "documentation":"

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

Specifies the name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

Specifies the value of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides a description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

Indicates the source of the parameter value.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

Specifies the engine specific parameters type.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

Specifies the valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

Specifies the valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest engine version to which the parameter can apply.

" + }, + "ApplyMethod":{ + "shape":"ApplyMethod", + "documentation":"

Indicates when to apply parameter updates.

" + } + }, + "documentation":"

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

" + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

Contains the pending or in-progress change of the master credentials for the DB instance.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending port for the DB instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending number of days for which automated backups are retained.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

" + } + }, + "documentation":"

This data type is used as a response element in the ModifyDBInstance action.

" + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

" + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

Example: mydbinstance

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

" + } + }, + "documentation":"

" + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

Customer-specified identifier to track this reservation.

Example: myreservationID

" + }, + "DBInstanceCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of instances to reserve.

Default: 1

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

" + }, + "ForceFailover":{ + "shape":"BooleanOptional", + "documentation":"

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

" + } + }, + "documentation":"

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

" + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

The frequency of the recurring charge.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the RDS event notification subscription you want to remove a source identifier from.

" + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

" + } + }, + "documentation":"

" + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

The tag key (name) of the tag to be removed.

" + } + }, + "documentation":"

" + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

The unique identifier for the reservation.

" + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class for the reserved DB instance.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The time the reservation started.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this reserved DB instance.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this reserved DB instance.

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved DB instance.

" + }, + "DBInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of reserved DB instances.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The description of the reserved DB instance.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type of this reserved DB instance.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Indicates if the reservation applies to Multi-AZ deployments.

" + }, + "State":{ + "shape":"String", + "documentation":"

The state of the reserved DB instance.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved DB instance.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

" + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

User already has a reservation with the given identifier.

" + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReservedDBInstances":{ + "shape":"ReservedDBInstanceList", + "documentation":"

A list of reserved DB instances.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

" + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified reserved DB Instance not found.

" + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would exceed the user's DB Instance quota.

" + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class for the reserved DB instance.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this offering.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this offering.

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved DB instance offering.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The database engine used by the offering.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Indicates if the offering applies to Multi-AZ deployments.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved DB instance.

" + } + }, + "wrapper":true, + "documentation":"

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReservedDBInstancesOfferings":{ + "shape":"ReservedDBInstancesOfferingList", + "documentation":"

A list of reserved DB instance offerings.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

" + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Specified offering does not exist.

" + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

Constraints:

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

" + } + }, + "documentation":"

" + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB snapshot to restore from.

Constraints:

" + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

Name of the DB instance to create from the DB snapshot. This parameter isn't case sensitive.

Constraints:

Example: my-snapshot-id

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The DB subnet group name to use for the new instance.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The database name for the restored DB instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Example: oracle-ee

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":[ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members":{ + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the source DB instance from which to restore.

Constraints:

" + }, + "TargetDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The name of the new database instance to be created.

Constraints:

" + }, + "RestoreTime":{ + "shape":"TStamp", + "documentation":"

The date and time to restore from.

Valid Values: Value must be a UTC time

Constraints:

Example: 2009-09-07T23:45:00Z

" + }, + "UseLatestRestorableTime":{ + "shape":"Boolean", + "documentation":"

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

Default: The same DBInstanceClass as the original DB instance.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The DB subnet group name to use for the new instance.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The database name for the restored DB instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Example: oracle-ee

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

" + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

" + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB security group to revoke ingress from.

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "documentation":"

" + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the SNS topic ARN.

" + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The SNS topic ARN does not exist.

" + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested source could not be found.

" + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier of the subnet.

" + }, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{ + "shape":"String", + "documentation":"

Specifies the status of the subnet.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeDBSubnetGroups action.

" + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The DB subnet is already in use in the Availability Zone.

" + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied subscription name already exists.

" + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The supplied category does not exist.

" + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The subscription name does not exist.

" + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + }, + "Value":{ + "shape":"String", + "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + } + }, + "documentation":"

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + }, + "documentation":"

A list of tags.

" + }, + "TagListMessage":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

List of tags returned by the ListTagsForResource operation.

" + } + }, + "documentation":"

" + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

The name of the VPC security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the VPC security group.

" + } + }, + "documentation":"

This data type is used as a response element for queries on VPC security group membership.

" + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + } + } +} diff --git a/apis/rds-2013-09-09.paginators.json b/apis/rds-2013-09-09.paginators.json new file mode 100644 index 0000000000..662845c12c --- /dev/null +++ b/apis/rds-2013-09-09.paginators.json @@ -0,0 +1,110 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "result_key": "LogFileData" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} diff --git a/apis/rds-2013-09-09.waiters.json b/apis/rds-2013-09-09.waiters.json new file mode 100644 index 0000000000..643412798a --- /dev/null +++ b/apis/rds-2013-09-09.waiters.json @@ -0,0 +1,36 @@ +{ + "waiters": { + "__default__": { + "interval": 30, + "max_attempts": 60 + }, + "__DBInstanceState": { + "operation": "DescribeDBInstances", + "acceptor_path": "DBInstances[].DBInstanceStatus", + "acceptor_type": "output" + }, + "DBInstanceAvailable": { + "extends": "__DBInstanceState", + "success_value": "available", + "failure_value": [ + "deleted", + "deleting", + "failed", + "incompatible-restore", + "incompatible-parameters", + "incompatible-parameters", + "incompatible-restore" + ] + }, + "DBInstanceDeleted": { + "extends": "__DBInstanceState", + "success_value": "deleted", + "failure_value": [ + "creating", + "modifying", + "rebooting", + "resetting-master-credentials" + ] + } + } +} diff --git a/apis/redshift-2012-12-01.api.json b/apis/redshift-2012-12-01.api.json new file mode 100644 index 0000000000..74f25ff720 --- /dev/null +++ b/apis/redshift-2012-12-01.api.json @@ -0,0 +1,1876 @@ +{ + "metadata": { + "apiVersion": "2012-12-01", + "endpointPrefix": "redshift", + "serviceFullName": "Amazon Redshift", + "signatureVersion": "v4", + "xmlNamespace": "http://redshift.amazonaws.com/doc/2012-12-01/", + "protocol": "query" + }, + "operations": { + "AuthorizeClusterSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "ClusterSecurityGroupName" + ], + "members": { + "ClusterSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AuthorizeClusterSecurityGroupIngressResult", + "type": "structure", + "members": { + "ClusterSecurityGroup": { + "shape": "S4" + } + } + } + }, + "AuthorizeSnapshotAccess": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members": { + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {}, + "AccountWithRestoreAccess": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "AuthorizeSnapshotAccessResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sb" + } + } + } + }, + "CopyClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SourceSnapshotIdentifier", + "TargetSnapshotIdentifier" + ], + "members": { + "SourceSnapshotIdentifier": {}, + "SourceSnapshotClusterIdentifier": {}, + "TargetSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CopyClusterSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sb" + } + } + } + }, + "CreateCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "NodeType", + "MasterUsername", + "MasterUserPassword" + ], + "members": { + "DBName": {}, + "ClusterIdentifier": {}, + "ClusterType": {}, + "NodeType": {}, + "MasterUsername": {}, + "MasterUserPassword": {}, + "ClusterSecurityGroups": { + "shape": "Sm" + }, + "VpcSecurityGroupIds": { + "shape": "Sn" + }, + "ClusterSubnetGroupName": {}, + "AvailabilityZone": {}, + "PreferredMaintenanceWindow": {}, + "ClusterParameterGroupName": {}, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "Port": { + "type": "integer" + }, + "ClusterVersion": {}, + "AllowVersionUpgrade": { + "type": "boolean" + }, + "NumberOfNodes": { + "type": "integer" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "Encrypted": { + "type": "boolean" + }, + "HsmClientCertificateIdentifier": {}, + "HsmConfigurationIdentifier": {}, + "ElasticIp": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + }, + "CreateClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName", + "ParameterGroupFamily", + "Description" + ], + "members": { + "ParameterGroupName": {}, + "ParameterGroupFamily": {}, + "Description": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateClusterParameterGroupResult", + "type": "structure", + "members": { + "ClusterParameterGroup": { + "shape": "S18" + } + } + } + }, + "CreateClusterSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSecurityGroupName", + "Description" + ], + "members": { + "ClusterSecurityGroupName": {}, + "Description": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateClusterSecurityGroupResult", + "type": "structure", + "members": { + "ClusterSecurityGroup": { + "shape": "S4" + } + } + } + }, + "CreateClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifier", + "ClusterIdentifier" + ], + "members": { + "SnapshotIdentifier": {}, + "ClusterIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateClusterSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sb" + } + } + } + }, + "CreateClusterSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSubnetGroupName", + "Description", + "SubnetIds" + ], + "members": { + "ClusterSubnetGroupName": {}, + "Description": {}, + "SubnetIds": { + "shape": "S1e" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateClusterSubnetGroupResult", + "type": "structure", + "members": { + "ClusterSubnetGroup": { + "shape": "S1g" + } + } + } + }, + "CreateEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName", + "SnsTopicArn" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "SourceIds": { + "shape": "S1l" + }, + "EventCategories": { + "shape": "S1m" + }, + "Severity": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S1o" + } + } + } + }, + "CreateHsmClientCertificate": { + "input": { + "type": "structure", + "required": [ + "HsmClientCertificateIdentifier" + ], + "members": { + "HsmClientCertificateIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateHsmClientCertificateResult", + "type": "structure", + "members": { + "HsmClientCertificate": { + "shape": "S1r" + } + } + } + }, + "CreateHsmConfiguration": { + "input": { + "type": "structure", + "required": [ + "HsmConfigurationIdentifier", + "Description", + "HsmIpAddress", + "HsmPartitionName", + "HsmPartitionPassword", + "HsmServerPublicCertificate" + ], + "members": { + "HsmConfigurationIdentifier": {}, + "Description": {}, + "HsmIpAddress": {}, + "HsmPartitionName": {}, + "HsmPartitionPassword": {}, + "HsmServerPublicCertificate": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "CreateHsmConfigurationResult", + "type": "structure", + "members": { + "HsmConfiguration": { + "shape": "S1u" + } + } + } + }, + "DeleteCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "SkipFinalClusterSnapshot": { + "type": "boolean" + }, + "FinalClusterSnapshotIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + }, + "DeleteClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {} + } + } + }, + "DeleteClusterSecurityGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSecurityGroupName" + ], + "members": { + "ClusterSecurityGroupName": {} + } + } + }, + "DeleteClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifier" + ], + "members": { + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DeleteClusterSnapshotResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sb" + } + } + } + }, + "DeleteClusterSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSubnetGroupName" + ], + "members": { + "ClusterSubnetGroupName": {} + } + } + }, + "DeleteEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {} + } + } + }, + "DeleteHsmClientCertificate": { + "input": { + "type": "structure", + "required": [ + "HsmClientCertificateIdentifier" + ], + "members": { + "HsmClientCertificateIdentifier": {} + } + } + }, + "DeleteHsmConfiguration": { + "input": { + "type": "structure", + "required": [ + "HsmConfigurationIdentifier" + ], + "members": { + "HsmConfigurationIdentifier": {} + } + } + }, + "DescribeClusterParameterGroups": { + "input": { + "type": "structure", + "members": { + "ParameterGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterParameterGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "ParameterGroups": { + "type": "list", + "member": { + "shape": "S18", + "locationName": "ClusterParameterGroup" + } + } + } + } + }, + "DescribeClusterParameters": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {}, + "Source": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterParametersResult", + "type": "structure", + "members": { + "Parameters": { + "shape": "S2a" + }, + "Marker": {} + } + } + }, + "DescribeClusterSecurityGroups": { + "input": { + "type": "structure", + "members": { + "ClusterSecurityGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterSecurityGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "ClusterSecurityGroups": { + "type": "list", + "member": { + "shape": "S4", + "locationName": "ClusterSecurityGroup" + } + } + } + } + }, + "DescribeClusterSnapshots": { + "input": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "SnapshotType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {}, + "OwnerAccount": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterSnapshotsResult", + "type": "structure", + "members": { + "Marker": {}, + "Snapshots": { + "type": "list", + "member": { + "shape": "Sb", + "locationName": "Snapshot" + } + } + } + } + }, + "DescribeClusterSubnetGroups": { + "input": { + "type": "structure", + "members": { + "ClusterSubnetGroupName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterSubnetGroupsResult", + "type": "structure", + "members": { + "Marker": {}, + "ClusterSubnetGroups": { + "type": "list", + "member": { + "shape": "S1g", + "locationName": "ClusterSubnetGroup" + } + } + } + } + }, + "DescribeClusterVersions": { + "input": { + "type": "structure", + "members": { + "ClusterVersion": {}, + "ClusterParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClusterVersionsResult", + "type": "structure", + "members": { + "Marker": {}, + "ClusterVersions": { + "type": "list", + "member": { + "locationName": "ClusterVersion", + "type": "structure", + "members": { + "ClusterVersion": {}, + "ClusterParameterGroupFamily": {}, + "Description": {} + } + } + } + } + } + }, + "DescribeClusters": { + "input": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeClustersResult", + "type": "structure", + "members": { + "Marker": {}, + "Clusters": { + "type": "list", + "member": { + "shape": "Sr", + "locationName": "Cluster" + } + } + } + } + }, + "DescribeDefaultClusterParameters": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupFamily" + ], + "members": { + "ParameterGroupFamily": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DescribeDefaultClusterParametersResult", + "type": "structure", + "members": { + "DefaultClusterParameters": { + "type": "structure", + "members": { + "ParameterGroupFamily": {}, + "Marker": {}, + "Parameters": { + "shape": "S2a" + } + }, + "wrapper": true + } + } + } + }, + "DescribeEventCategories": { + "input": { + "type": "structure", + "members": { + "SourceType": {} + } + }, + "output": { + "resultWrapper": "DescribeEventCategoriesResult", + "type": "structure", + "members": { + "EventCategoriesMapList": { + "type": "list", + "member": { + "locationName": "EventCategoriesMap", + "type": "structure", + "members": { + "SourceType": {}, + "Events": { + "type": "list", + "member": { + "locationName": "EventInfoMap", + "type": "structure", + "members": { + "EventId": {}, + "EventCategories": { + "shape": "S1m" + }, + "EventDescription": {}, + "Severity": {} + }, + "wrapper": true + } + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeEventSubscriptions": { + "input": { + "type": "structure", + "members": { + "SubscriptionName": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventSubscriptionsResult", + "type": "structure", + "members": { + "Marker": {}, + "EventSubscriptionsList": { + "type": "list", + "member": { + "shape": "S1o", + "locationName": "EventSubscription" + } + } + } + } + }, + "DescribeEvents": { + "input": { + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeEventsResult", + "type": "structure", + "members": { + "Marker": {}, + "Events": { + "type": "list", + "member": { + "locationName": "Event", + "type": "structure", + "members": { + "SourceIdentifier": {}, + "SourceType": {}, + "Message": {}, + "EventCategories": { + "shape": "S1m" + }, + "Severity": {}, + "Date": { + "type": "timestamp" + }, + "EventId": {} + } + } + } + } + } + }, + "DescribeHsmClientCertificates": { + "input": { + "type": "structure", + "members": { + "HsmClientCertificateIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeHsmClientCertificatesResult", + "type": "structure", + "members": { + "Marker": {}, + "HsmClientCertificates": { + "type": "list", + "member": { + "shape": "S1r", + "locationName": "HsmClientCertificate" + } + } + } + } + }, + "DescribeHsmConfigurations": { + "input": { + "type": "structure", + "members": { + "HsmConfigurationIdentifier": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeHsmConfigurationsResult", + "type": "structure", + "members": { + "Marker": {}, + "HsmConfigurations": { + "type": "list", + "member": { + "shape": "S1u", + "locationName": "HsmConfiguration" + } + } + } + } + }, + "DescribeLoggingStatus": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "shape": "S3g", + "resultWrapper": "DescribeLoggingStatusResult" + } + }, + "DescribeOrderableClusterOptions": { + "input": { + "type": "structure", + "members": { + "ClusterVersion": {}, + "NodeType": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeOrderableClusterOptionsResult", + "type": "structure", + "members": { + "OrderableClusterOptions": { + "type": "list", + "member": { + "locationName": "OrderableClusterOption", + "type": "structure", + "members": { + "ClusterVersion": {}, + "ClusterType": {}, + "NodeType": {}, + "AvailabilityZones": { + "type": "list", + "member": { + "shape": "S1j", + "locationName": "AvailabilityZone" + } + } + }, + "wrapper": true + } + }, + "Marker": {} + } + } + }, + "DescribeReservedNodeOfferings": { + "input": { + "type": "structure", + "members": { + "ReservedNodeOfferingId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedNodeOfferingsResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedNodeOfferings": { + "type": "list", + "member": { + "locationName": "ReservedNodeOffering", + "type": "structure", + "members": { + "ReservedNodeOfferingId": {}, + "NodeType": {}, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "OfferingType": {}, + "RecurringCharges": { + "shape": "S3q" + } + }, + "wrapper": true + } + } + } + } + }, + "DescribeReservedNodes": { + "input": { + "type": "structure", + "members": { + "ReservedNodeId": {}, + "MaxRecords": { + "type": "integer" + }, + "Marker": {} + } + }, + "output": { + "resultWrapper": "DescribeReservedNodesResult", + "type": "structure", + "members": { + "Marker": {}, + "ReservedNodes": { + "type": "list", + "member": { + "shape": "S3v", + "locationName": "ReservedNode" + } + } + } + } + }, + "DescribeResize": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "resultWrapper": "DescribeResizeResult", + "type": "structure", + "members": { + "TargetNodeType": {}, + "TargetNumberOfNodes": { + "type": "integer" + }, + "TargetClusterType": {}, + "Status": {}, + "ImportTablesCompleted": { + "type": "list", + "member": {} + }, + "ImportTablesInProgress": { + "type": "list", + "member": {} + }, + "ImportTablesNotStarted": { + "type": "list", + "member": {} + }, + "AvgResizeRateInMegaBytesPerSecond": { + "type": "double" + }, + "TotalResizeDataInMegaBytes": { + "type": "long" + }, + "ProgressInMegaBytes": { + "type": "long" + }, + "ElapsedTimeInSeconds": { + "type": "long" + }, + "EstimatedTimeToCompletionInSeconds": { + "type": "long" + } + } + } + }, + "DisableLogging": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "shape": "S3g", + "resultWrapper": "DisableLoggingResult" + } + }, + "DisableSnapshotCopy": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "DisableSnapshotCopyResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + }, + "EnableLogging": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "BucketName" + ], + "members": { + "ClusterIdentifier": {}, + "BucketName": {}, + "S3KeyPrefix": {} + } + }, + "output": { + "shape": "S3g", + "resultWrapper": "EnableLoggingResult" + } + }, + "EnableSnapshotCopy": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "DestinationRegion" + ], + "members": { + "ClusterIdentifier": {}, + "DestinationRegion": {}, + "RetentionPeriod": { + "type": "integer" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "EnableSnapshotCopyResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + }, + "ModifyCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "ClusterType": {}, + "NodeType": {}, + "NumberOfNodes": { + "type": "integer" + }, + "ClusterSecurityGroups": { + "shape": "Sm" + }, + "VpcSecurityGroupIds": { + "shape": "Sn" + }, + "MasterUserPassword": {}, + "ClusterParameterGroupName": {}, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "PreferredMaintenanceWindow": {}, + "ClusterVersion": {}, + "AllowVersionUpgrade": { + "type": "boolean" + }, + "HsmClientCertificateIdentifier": {}, + "HsmConfigurationIdentifier": {}, + "NewClusterIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + }, + "ModifyClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName", + "Parameters" + ], + "members": { + "ParameterGroupName": {}, + "Parameters": { + "shape": "S2a" + } + } + }, + "output": { + "shape": "S4c", + "resultWrapper": "ModifyClusterParameterGroupResult" + } + }, + "ModifyClusterSubnetGroup": { + "input": { + "type": "structure", + "required": [ + "ClusterSubnetGroupName", + "SubnetIds" + ], + "members": { + "ClusterSubnetGroupName": {}, + "Description": {}, + "SubnetIds": { + "shape": "S1e" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyClusterSubnetGroupResult", + "type": "structure", + "members": { + "ClusterSubnetGroup": { + "shape": "S1g" + } + } + } + }, + "ModifyEventSubscription": { + "input": { + "type": "structure", + "required": [ + "SubscriptionName" + ], + "members": { + "SubscriptionName": {}, + "SnsTopicArn": {}, + "SourceType": {}, + "SourceIds": { + "shape": "S1l" + }, + "EventCategories": { + "shape": "S1m" + }, + "Severity": {}, + "Enabled": { + "type": "boolean" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifyEventSubscriptionResult", + "type": "structure", + "members": { + "EventSubscription": { + "shape": "S1o" + } + } + } + }, + "ModifySnapshotCopyRetentionPeriod": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "RetentionPeriod" + ], + "members": { + "ClusterIdentifier": {}, + "RetentionPeriod": { + "type": "integer" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "ModifySnapshotCopyRetentionPeriodResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + }, + "PurchaseReservedNodeOffering": { + "input": { + "type": "structure", + "required": [ + "ReservedNodeOfferingId" + ], + "members": { + "ReservedNodeOfferingId": {}, + "NodeCount": { + "type": "integer" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "PurchaseReservedNodeOfferingResult", + "type": "structure", + "members": { + "ReservedNode": { + "shape": "S3v" + } + } + } + }, + "RebootCluster": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RebootClusterResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + }, + "ResetClusterParameterGroup": { + "input": { + "type": "structure", + "required": [ + "ParameterGroupName" + ], + "members": { + "ParameterGroupName": {}, + "ResetAllParameters": { + "type": "boolean" + }, + "Parameters": { + "shape": "S2a" + } + } + }, + "output": { + "shape": "S4c", + "resultWrapper": "ResetClusterParameterGroupResult" + } + }, + "RestoreFromClusterSnapshot": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier", + "SnapshotIdentifier" + ], + "members": { + "ClusterIdentifier": {}, + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "AllowVersionUpgrade": { + "type": "boolean" + }, + "ClusterSubnetGroupName": {}, + "PubliclyAccessible": { + "type": "boolean" + }, + "OwnerAccount": {}, + "HsmClientCertificateIdentifier": {}, + "HsmConfigurationIdentifier": {}, + "ElasticIp": {}, + "ClusterParameterGroupName": {}, + "ClusterSecurityGroups": { + "shape": "Sm" + }, + "VpcSecurityGroupIds": { + "shape": "Sn" + }, + "PreferredMaintenanceWindow": {}, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + } + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RestoreFromClusterSnapshotResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + }, + "RevokeClusterSecurityGroupIngress": { + "input": { + "type": "structure", + "required": [ + "ClusterSecurityGroupName" + ], + "members": { + "ClusterSecurityGroupName": {}, + "CIDRIP": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RevokeClusterSecurityGroupIngressResult", + "type": "structure", + "members": { + "ClusterSecurityGroup": { + "shape": "S4" + } + } + } + }, + "RevokeSnapshotAccess": { + "input": { + "type": "structure", + "required": [ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members": { + "SnapshotIdentifier": {}, + "SnapshotClusterIdentifier": {}, + "AccountWithRestoreAccess": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RevokeSnapshotAccessResult", + "type": "structure", + "members": { + "Snapshot": { + "shape": "Sb" + } + } + } + }, + "RotateEncryptionKey": { + "input": { + "type": "structure", + "required": [ + "ClusterIdentifier" + ], + "members": { + "ClusterIdentifier": {} + } + }, + "output": { + "wrapper": true, + "resultWrapper": "RotateEncryptionKeyResult", + "type": "structure", + "members": { + "Cluster": { + "shape": "Sr" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "ClusterSecurityGroupName": {}, + "Description": {}, + "EC2SecurityGroups": { + "type": "list", + "member": { + "locationName": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": {}, + "EC2SecurityGroupName": {}, + "EC2SecurityGroupOwnerId": {} + } + } + }, + "IPRanges": { + "type": "list", + "member": { + "locationName": "IPRange", + "type": "structure", + "members": { + "Status": {}, + "CIDRIP": {} + } + } + } + }, + "wrapper": true + }, + "Sb": { + "type": "structure", + "members": { + "SnapshotIdentifier": {}, + "ClusterIdentifier": {}, + "SnapshotCreateTime": { + "type": "timestamp" + }, + "Status": {}, + "Port": { + "type": "integer" + }, + "AvailabilityZone": {}, + "ClusterCreateTime": { + "type": "timestamp" + }, + "MasterUsername": {}, + "ClusterVersion": {}, + "SnapshotType": {}, + "NodeType": {}, + "NumberOfNodes": { + "type": "integer" + }, + "DBName": {}, + "VpcId": {}, + "Encrypted": { + "type": "boolean" + }, + "EncryptedWithHSM": { + "type": "boolean" + }, + "AccountsWithRestoreAccess": { + "type": "list", + "member": { + "locationName": "AccountWithRestoreAccess", + "type": "structure", + "members": { + "AccountId": {} + } + } + }, + "OwnerAccount": {}, + "TotalBackupSizeInMegaBytes": { + "type": "double" + }, + "ActualIncrementalBackupSizeInMegaBytes": { + "type": "double" + }, + "BackupProgressInMegaBytes": { + "type": "double" + }, + "CurrentBackupRateInMegaBytesPerSecond": { + "type": "double" + }, + "EstimatedSecondsToCompletion": { + "type": "long" + }, + "ElapsedTimeInSeconds": { + "type": "long" + }, + "SourceRegion": {} + }, + "wrapper": true + }, + "Sm": { + "type": "list", + "member": { + "locationName": "ClusterSecurityGroupName" + } + }, + "Sn": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroupId" + } + }, + "Sr": { + "type": "structure", + "members": { + "ClusterIdentifier": {}, + "NodeType": {}, + "ClusterStatus": {}, + "ModifyStatus": {}, + "MasterUsername": {}, + "DBName": {}, + "Endpoint": { + "type": "structure", + "members": { + "Address": {}, + "Port": { + "type": "integer" + } + } + }, + "ClusterCreateTime": { + "type": "timestamp" + }, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "ClusterSecurityGroups": { + "type": "list", + "member": { + "locationName": "ClusterSecurityGroup", + "type": "structure", + "members": { + "ClusterSecurityGroupName": {}, + "Status": {} + } + } + }, + "VpcSecurityGroups": { + "type": "list", + "member": { + "locationName": "VpcSecurityGroup", + "type": "structure", + "members": { + "VpcSecurityGroupId": {}, + "Status": {} + } + } + }, + "ClusterParameterGroups": { + "type": "list", + "member": { + "locationName": "ClusterParameterGroup", + "type": "structure", + "members": { + "ParameterGroupName": {}, + "ParameterApplyStatus": {} + } + } + }, + "ClusterSubnetGroupName": {}, + "VpcId": {}, + "AvailabilityZone": {}, + "PreferredMaintenanceWindow": {}, + "PendingModifiedValues": { + "type": "structure", + "members": { + "MasterUserPassword": {}, + "NodeType": {}, + "NumberOfNodes": { + "type": "integer" + }, + "ClusterType": {}, + "ClusterVersion": {}, + "AutomatedSnapshotRetentionPeriod": { + "type": "integer" + }, + "ClusterIdentifier": {} + } + }, + "ClusterVersion": {}, + "AllowVersionUpgrade": { + "type": "boolean" + }, + "NumberOfNodes": { + "type": "integer" + }, + "PubliclyAccessible": { + "type": "boolean" + }, + "Encrypted": { + "type": "boolean" + }, + "RestoreStatus": { + "type": "structure", + "members": { + "Status": {}, + "CurrentRestoreRateInMegaBytesPerSecond": { + "type": "double" + }, + "SnapshotSizeInMegaBytes": { + "type": "long" + }, + "ProgressInMegaBytes": { + "type": "long" + }, + "ElapsedTimeInSeconds": { + "type": "long" + }, + "EstimatedTimeToCompletionInSeconds": { + "type": "long" + } + } + }, + "HsmStatus": { + "type": "structure", + "members": { + "HsmClientCertificateIdentifier": {}, + "HsmConfigurationIdentifier": {}, + "Status": {} + } + }, + "ClusterSnapshotCopyStatus": { + "type": "structure", + "members": { + "DestinationRegion": {}, + "RetentionPeriod": { + "type": "long" + } + } + }, + "ClusterPublicKey": {}, + "ClusterNodes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "NodeRole": {}, + "PrivateIPAddress": {}, + "PublicIPAddress": {} + } + } + }, + "ElasticIpStatus": { + "type": "structure", + "members": { + "ElasticIp": {}, + "Status": {} + } + }, + "ClusterRevisionNumber": {} + }, + "wrapper": true + }, + "S18": { + "type": "structure", + "members": { + "ParameterGroupName": {}, + "ParameterGroupFamily": {}, + "Description": {} + }, + "wrapper": true + }, + "S1e": { + "type": "list", + "member": { + "locationName": "SubnetIdentifier" + } + }, + "S1g": { + "type": "structure", + "members": { + "ClusterSubnetGroupName": {}, + "Description": {}, + "VpcId": {}, + "SubnetGroupStatus": {}, + "Subnets": { + "type": "list", + "member": { + "locationName": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": {}, + "SubnetAvailabilityZone": { + "shape": "S1j" + }, + "SubnetStatus": {} + } + } + } + }, + "wrapper": true + }, + "S1j": { + "type": "structure", + "members": { + "Name": {} + }, + "wrapper": true + }, + "S1l": { + "type": "list", + "member": { + "locationName": "SourceId" + } + }, + "S1m": { + "type": "list", + "member": { + "locationName": "EventCategory" + } + }, + "S1o": { + "type": "structure", + "members": { + "CustomerAwsId": {}, + "CustSubscriptionId": {}, + "SnsTopicArn": {}, + "Status": {}, + "SubscriptionCreationTime": { + "type": "timestamp" + }, + "SourceType": {}, + "SourceIdsList": { + "shape": "S1l" + }, + "EventCategoriesList": { + "shape": "S1m" + }, + "Severity": {}, + "Enabled": { + "type": "boolean" + } + }, + "wrapper": true + }, + "S1r": { + "type": "structure", + "members": { + "HsmClientCertificateIdentifier": {}, + "HsmClientCertificatePublicKey": {} + }, + "wrapper": true + }, + "S1u": { + "type": "structure", + "members": { + "HsmConfigurationIdentifier": {}, + "Description": {}, + "HsmIpAddress": {}, + "HsmPartitionName": {} + }, + "wrapper": true + }, + "S2a": { + "type": "list", + "member": { + "locationName": "Parameter", + "type": "structure", + "members": { + "ParameterName": {}, + "ParameterValue": {}, + "Description": {}, + "Source": {}, + "DataType": {}, + "AllowedValues": {}, + "IsModifiable": { + "type": "boolean" + }, + "MinimumEngineVersion": {} + } + } + }, + "S3g": { + "type": "structure", + "members": { + "LoggingEnabled": { + "type": "boolean" + }, + "BucketName": {}, + "S3KeyPrefix": {}, + "LastSuccessfulDeliveryTime": { + "type": "timestamp" + }, + "LastFailureTime": { + "type": "timestamp" + }, + "LastFailureMessage": {} + } + }, + "S3q": { + "type": "list", + "member": { + "locationName": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "type": "double" + }, + "RecurringChargeFrequency": {} + }, + "wrapper": true + } + }, + "S3v": { + "type": "structure", + "members": { + "ReservedNodeId": {}, + "ReservedNodeOfferingId": {}, + "NodeType": {}, + "StartTime": { + "type": "timestamp" + }, + "Duration": { + "type": "integer" + }, + "FixedPrice": { + "type": "double" + }, + "UsagePrice": { + "type": "double" + }, + "CurrencyCode": {}, + "NodeCount": { + "type": "integer" + }, + "State": {}, + "OfferingType": {}, + "RecurringCharges": { + "shape": "S3q" + } + }, + "wrapper": true + }, + "S4c": { + "type": "structure", + "members": { + "ParameterGroupName": {}, + "ParameterGroupStatus": {} + } + } + } +} \ No newline at end of file diff --git a/apis/redshift-2012-12-01.full.json b/apis/redshift-2012-12-01.full.json new file mode 100644 index 0000000000..92fadc73aa --- /dev/null +++ b/apis/redshift-2012-12-01.full.json @@ -0,0 +1,6318 @@ +{ + "metadata":{ + "apiVersion":"2012-12-01", + "endpointPrefix":"redshift", + "serviceFullName":"Amazon Redshift", + "signatureVersion":"v4", + "xmlNamespace":"http://redshift.amazonaws.com/doc/2012-12-01/", + "protocol":"query" + }, + "documentation":"Amazon Redshift\n Overview\n

\n This is an interface reference for Amazon Redshift. It contains documentation for one of the\n programming or command line interfaces you can use to manage Amazon Redshift clusters. Note\n that Amazon Redshift is asynchronous, which means that some interfaces may require techniques,\n such as polling or asynchronous callback handlers, to determine when a command has been\n applied. In this reference, the parameter descriptions indicate whether a change is\n applied immediately, on the next instance reboot, or during the next maintenance\n window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces\n .

\n

\n Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: \n provisioning capacity, monitoring and backing up the cluster, and applying patches and \n upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new \n insights for your business and customers.\n

\n

If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the\n The Amazon Redshift Getting Started Guide

\n\n

If you are a database developer, the Amazon Redshift Database Developer Guide\n explains how to design, build, query, and maintain the databases that make up your\n data warehouse.

", + "operations":{ + "AuthorizeClusterSecurityGroupIngress":{ + "name":"AuthorizeClusterSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AuthorizeClusterSecurityGroupIngressMessage", + "documentation":"

\n ???\n

" + }, + "output":{ + "shape":"AuthorizeClusterSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Describes a security group.

", + "resultWrapper":"AuthorizeClusterSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"ClusterSecurityGroupNotFoundFault", + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster security group name does not refer to an existing cluster security group.\n

" + }, + { + "shape":"InvalidClusterSecurityGroupStateFault", + "error":{ + "code":"InvalidClusterSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster security group is not available.\n

" + }, + { + "shape":"AuthorizationAlreadyExistsFault", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.\n

" + }, + { + "shape":"AuthorizationQuotaExceededFault", + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The authorization quota for the cluster security group has been reached.\n

" + } + ], + "documentation":"

\n Adds an inbound (ingress) rule to an Amazon Redshift security group. \n Depending on whether the application accessing your cluster is running \n on the Internet or an EC2 instance, you can \n authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range\n or an EC2 security group. \n You can add as many as 20 ingress rules to an Amazon Redshift security group. \n

\n \n The EC2 security group must be defined in the AWS region where the cluster resides.\n \n

For an overview of CIDR blocks, see the Wikipedia article on \n Classless Inter-Domain Routing.\n

\n

\n You must also associate the security group with a cluster so that clients \n running on these IP addresses or the EC2 instance are authorized to connect to the cluster.\n For information about managing security groups, go to\n Working with Security Groups in the \n Amazon Redshift Management Guide.

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=AuthorizeClusterSecurityGroupIngress\n &CIDRIP=192.168.40.3/32\n &ClusterSecurityGroupName=securitygroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T020649Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n \n 192.168.40.3/32\n authorized\n \n \n my security group\n securitygroup1\n \n \n \n 8c7cd4c8-6501-11e2-a8da-655adc216806\n \n\n " + }, + "AuthorizeSnapshotAccess":{ + "name":"AuthorizeSnapshotAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AuthorizeSnapshotAccessMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"AuthorizeSnapshotAccessResult", + "wrapper":true, + "documentation":"

Describes a snapshot.

", + "resultWrapper":"AuthorizeSnapshotAccessResult" + }, + "errors":[ + { + "shape":"ClusterSnapshotNotFoundFault", + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

" + }, + { + "shape":"AuthorizationAlreadyExistsFault", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.\n

" + }, + { + "shape":"AuthorizationQuotaExceededFault", + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The authorization quota for the cluster security group has been reached.\n

" + } + ], + "documentation":"

\n Authorizes the specified AWS customer account to restore the specified snapshot.\n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

" + }, + "CopyClusterSnapshot":{ + "name":"CopyClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopyClusterSnapshotMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"CopyClusterSnapshotResult", + "wrapper":true, + "documentation":"

Describes a snapshot.

", + "resultWrapper":"CopyClusterSnapshotResult" + }, + "errors":[ + { + "shape":"ClusterSnapshotAlreadyExistsFault", + "error":{ + "code":"ClusterSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The value specified as a snapshot identifier is already used by an existing snapshot.\n

" + }, + { + "shape":"ClusterSnapshotNotFoundFault", + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

" + }, + { + "shape":"InvalidClusterSnapshotStateFault", + "error":{ + "code":"InvalidClusterSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.\n

" + }, + { + "shape":"ClusterSnapshotQuotaExceededFault", + "error":{ + "code":"ClusterSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in the user exceeding the allowed number of cluster snapshots.\n

" + } + ], + "documentation":"

\n Copies the specified automated cluster snapshot to a new manual cluster snapshot. \n The source must be an automated snapshot and it must be in the available state.\n

\n

\n When you delete a cluster, Amazon Redshift deletes any automated snapshots \n of the cluster. Also, when the retention period of the snapshot expires,\n Amazon Redshift automatically deletes it. If you want to keep an \n automated snapshot for a longer period, you can make a manual\n copy of the snapshot. Manual snapshots are retained until you delete them. \n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CopyClusterSnapshot\n &SourceSnapshotIdentifier=cm:examplecluster-2013-01-22-19-27-58\n &TargetSnapshotIdentifier=my-snapshot-456\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T014618Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n 5439\n my-snapshot-456\n available\n manual\n 1.0\n 2013-01-22T19:27:58.931Z\n 2\n dev\n 2013-01-22T19:23:59.368Z\n us-east-1c\n dw1.xlarge\n examplecluster\n adminuser\n \n \n \n aebb56f5-64fe-11e2-88c5-53eb05787dfb\n \n\n " + }, + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateClusterMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateClusterResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"CreateClusterResult" + }, + "errors":[ + { + "shape":"ClusterAlreadyExistsFault", + "error":{ + "code":"ClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The account already has a cluster with the given identifier.\n

" + }, + { + "shape":"InsufficientClusterCapacityFault", + "error":{ + "code":"InsufficientClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The number of nodes specified exceeds the allotted capacity of the cluster.\n

" + }, + { + "shape":"ClusterParameterGroupNotFoundFault", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + }, + { + "shape":"ClusterSecurityGroupNotFoundFault", + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster security group name does not refer to an existing cluster security group.\n

" + }, + { + "shape":"ClusterQuotaExceededFault", + "error":{ + "code":"ClusterQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would exceed the allowed number of cluster instances for this account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + { + "shape":"NumberOfNodesQuotaExceededFault", + "error":{ + "code":"NumberOfNodesQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The operation would exceed the number of nodes allotted to the account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n

" + }, + { + "shape":"NumberOfNodesPerClusterLimitExceededFault", + "error":{ + "code":"NumberOfNodesPerClusterLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The operation would exceed the number of nodes allowed for a cluster.

" + }, + { + "shape":"ClusterSubnetGroupNotFoundFault", + "error":{ + "code":"ClusterSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group does not cover all Availability Zones.\n

" + }, + { + "shape":"InvalidClusterSubnetGroupStateFault", + "error":{ + "code":"InvalidClusterSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group cannot be deleted because it is in use.\n

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

" + }, + { + "shape":"UnauthorizedOperation", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + }, + { + "shape":"HsmClientCertificateNotFoundFault", + "error":{ + "code":"HsmClientCertificateNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM client certificate with the specified identifier.

" + }, + { + "shape":"HsmConfigurationNotFoundFault", + "error":{ + "code":"HsmConfigurationNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM configuration with the specified identifier.

" + }, + { + "shape":"InvalidElasticIpFault", + "error":{ + "code":"InvalidElasticIpFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The Elastic IP (EIP) is invalid or cannot be found.

" + } + ], + "documentation":"

\n Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If \n you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift \n creates a non-VPC cluster, it associates the default cluster security group with the cluster.\n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n.\n

\n \n \n Create a non-VPC cluster.\n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateCluster\n &ClusterIdentifier=examplecluster\n &MasterUsername=masteruser\n &MasterUserPassword=12345678Aa\n &NumberOfNodes=2 \n &NodeType=dw1.xlarge\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T000028Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n ****\n \n 1.0\n \n creating\n 2\n 1\n true\n false\n dev\n sun:10:30-sun:11:00\n \n \n in-sync\n default.redshift-1.0\n \n \n \n \n active\n default\n \n \n dw1.xlarge\n examplecluster\n true\n masteruser\n \n \n \n e69b1294-64ef-11e2-b07c-f7fbdd006c67\n \n\n \n \n Create cluster in virtual private cloud (VPC). This example request specifies a ClusterSubnetGroup in the request.\n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateCluster\n&ClusterIdentifier=exampleclusterinvpc\n&MasterUsername=master\n&MasterUserPassword=1234abcdA\n&NodeType=dw1.xlarge\n&NumberOfNodes=2\n&ClusterSubnetGroupName=mysubnetgroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T000028Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n ****\n \n mysubnetgroup1\n 1.0\n \n creating\n 2\n 1\n false\n false\n dev\n sat:08:30-sat:09:00\n \n \n in-sync\n default.redshift-1.0\n \n \n vpc-796a5913\n \n dw1.xlarge\n exampleclusterinvpc\n true\n master\n \n \n \n fa337bb4-6a4d-11e2-a12a-cb8076a904bd\n \n\n \n " + }, + "CreateClusterParameterGroup":{ + "name":"CreateClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateClusterParameterGroupMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"CreateClusterParameterGroupResult", + "wrapper":true, + "documentation":"

Describes a parameter group.

", + "resultWrapper":"CreateClusterParameterGroupResult" + }, + "errors":[ + { + "shape":"ClusterParameterGroupQuotaExceededFault", + "error":{ + "code":"ClusterParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in the user exceeding the allowed\n number of cluster parameter groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + { + "shape":"ClusterParameterGroupAlreadyExistsFault", + "error":{ + "code":"ClusterParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n A cluster parameter group with the same name already exists.\n

" + } + ], + "documentation":"

\n Creates an Amazon Redshift parameter group.

\n

Creating parameter groups is independent of creating clusters. \n You can associate a cluster with a parameter group \n when you create the cluster. You can also associate an existing cluster\n with a parameter group after the cluster is created by using ModifyCluster.\n

\n

\n Parameters in the parameter group define specific behavior that applies to the \n databases you create on the cluster. \n \nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateClusterParameterGroup\n &Description=description my parameter group\n &ParameterGroupFamily=redshift-1.0\n &ParameterGroupName=parametergroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T002544Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n redshift-1.0\n description my parameter group\n parametergroup1\n \n \n \n 6d6df847-64f3-11e2-bea9-49e0ce183f07\n \n\n " + }, + "CreateClusterSecurityGroup":{ + "name":"CreateClusterSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateClusterSecurityGroupMessage", + "documentation":"

???

" + }, + "output":{ + "shape":"CreateClusterSecurityGroupResult", + "wrapper":true, + "documentation":"

Describes a security group.

", + "resultWrapper":"CreateClusterSecurityGroupResult" + }, + "errors":[ + { + "shape":"ClusterSecurityGroupAlreadyExistsFault", + "error":{ + "code":"ClusterSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n A cluster security group with the same name already exists.\n

" + }, + { + "shape":"ClusterSecurityGroupQuotaExceededFault", + "error":{ + "code":"QuotaExceeded.ClusterSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in the user exceeding the allowed number of cluster security groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + } + ], + "documentation":"

\n Creates a new Amazon Redshift security group. You use security \n groups to control access to non-VPC clusters. \n

\n

\n \nFor information about managing security groups, go to\nAmazon Redshift Cluster Security Groups in the \nAmazon Redshift Management Guide.\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateClusterSecurityGroup\n &ClusterSecurityGroupName=securitygroup1\n &Description=my security group\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T005817Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n my security group\n securitygroup1\n \n \n \n f9ee270f-64f7-11e2-a8da-655adc216806\n \n\n " + }, + "CreateClusterSnapshot":{ + "name":"CreateClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateClusterSnapshotMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"CreateClusterSnapshotResult", + "wrapper":true, + "documentation":"

Describes a snapshot.

", + "resultWrapper":"CreateClusterSnapshotResult" + }, + "errors":[ + { + "shape":"ClusterSnapshotAlreadyExistsFault", + "error":{ + "code":"ClusterSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The value specified as a snapshot identifier is already used by an existing snapshot.\n

" + }, + { + "shape":"InvalidClusterStateFault", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + }, + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"ClusterSnapshotQuotaExceededFault", + "error":{ + "code":"ClusterSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in the user exceeding the allowed number of cluster snapshots.\n

" + } + ], + "documentation":"

\n Creates a manual snapshot of the specified cluster. \n The cluster must be in the available state.\n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateClusterSnapshot\n &ClusterIdentifier=examplecluster\n &SnapshotIdentifier=snapshot-1234\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T010824Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n 5439\n my-snapshot-123\n creating\n manual\n 1.0\n 2013-01-23T01:08:29.142Z\n 2\n dev\n 2013-01-22T19:23:59.368Z\n us-east-1c\n dw1.xlarge\n examplecluster\n adminuser\n \n \n \n 65baef14-64f9-11e2-bea9-49e0ce183f07\n \n\n " + }, + "CreateClusterSubnetGroup":{ + "name":"CreateClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateClusterSubnetGroupMessage", + "documentation":"

\n

" + }, + "output":{ + "shape":"CreateClusterSubnetGroupResult", + "wrapper":true, + "documentation":"

Describes a subnet group.

", + "resultWrapper":"CreateClusterSubnetGroupResult" + }, + "errors":[ + { + "shape":"ClusterSubnetGroupAlreadyExistsFault", + "error":{ + "code":"ClusterSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n A ClusterSubnetGroupName is already used by an existing cluster subnet group.\n

" + }, + { + "shape":"ClusterSubnetGroupQuotaExceededFault", + "error":{ + "code":"ClusterSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in user exceeding the allowed number of cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + { + "shape":"ClusterSubnetQuotaExceededFault", + "error":{ + "code":"ClusterSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

" + }, + { + "shape":"UnauthorizedOperation", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + } + ], + "documentation":"

\n Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in \n your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.\n \n

\n

\nFor information about subnet groups, go to\nAmazon Redshift Cluster Subnet Groups in the \nAmazon Redshift Management Guide.\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateClusterSubnetGroup\n &ClusterSubnetGroupName=mysubnetgroup1\n &Description=My subnet group 1\n &SubnetIds.member.1=subnet-756a591f\n &SubnetIds.member.1=subnet-716a591b\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130129/us-east-1/redshift/aws4_request\n &x-amz-date=20130129T192820Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n vpc-796a5913\n My subnet group 1\n mysubnetgroup1\n Complete\n \n \n Active\n subnet-756a591f\n \n us-east-1c\n \n \n \n \n \n \n 0a60660f-6a4a-11e2-aad2-71d00c36728e\n \n\n " + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateEventSubscriptionResult", + "wrapper":true, + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would exceed the allowed number of event subscriptions for this account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + { + "shape":"SubscriptionAlreadyExistFault", + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is already an existing event notification subscription with the specified name.

" + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

" + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the specified Amazon SNS topic.

" + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

" + }, + { + "shape":"SubscriptionEventIdNotFoundFault", + "error":{ + "code":"SubscriptionEventIdNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon Redshift event with the specified event ID does not exist.

" + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The value specified for the event category was not one of the allowed values, or\n it specified a category that does not apply to the specified source type. The allowed\n values are Configuration, Management, Monitoring, and Security.

" + }, + { + "shape":"SubscriptionSeverityNotFoundFault", + "error":{ + "code":"SubscriptionSeverityNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The value specified for the event severity was not one of the allowed values, or\n it specified a severity that does not apply to the specified source type. The allowed\n values are ERROR and INFO.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon Redshift event source could not be found.

" + } + ], + "documentation":"

\n Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of\n an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the \n Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic.\n The ARN is displayed in the SNS console.\n

\n

\n You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities.\n Notifications will be sent for all events you want that match those criteria. For example, you can specify\n source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and\n severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and\n Backup categories for the specified clusters.\n

\n

\n If you specify both the source type and source IDs, such as source type = cluster and source identifier = \n my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type\n but do not specify a source identifier, you will receive notice of the events for the objects of that type in your\n AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events\n generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you\n specify a source ID.\n

" + }, + "CreateHsmClientCertificate":{ + "name":"CreateHsmClientCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateHsmClientCertificateMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateHsmClientCertificateResult", + "wrapper":true, + "documentation":"

Returns information about an HSM client certificate. The certificate is stored in a secure\n Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to\n encrypt data files.

", + "resultWrapper":"CreateHsmClientCertificateResult" + }, + "errors":[ + { + "shape":"HsmClientCertificateAlreadyExistsFault", + "error":{ + "code":"HsmClientCertificateAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is already an existing Amazon Redshift HSM client certificate with the specified identifier.

" + }, + { + "shape":"HsmClientCertificateQuotaExceededFault", + "error":{ + "code":"HsmClientCertificateQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The quota for HSM client certificates has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + } + ], + "documentation":"

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM\n in order to store and retrieve the keys used to encrypt the cluster databases.

\n

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate,\n you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to\n store and use encryption keys in the HSM. For more information, go to\n Hardware Security Modules in the Amazon Redshift Management Guide.

" + }, + "CreateHsmConfiguration":{ + "name":"CreateHsmConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateHsmConfigurationMessage", + "documentation":"

" + }, + "output":{ + "shape":"CreateHsmConfigurationResult", + "wrapper":true, + "documentation":"

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift\n clusters the information they require to connect to an HSM where they can store database\n encryption keys.

", + "resultWrapper":"CreateHsmConfigurationResult" + }, + "errors":[ + { + "shape":"HsmConfigurationAlreadyExistsFault", + "error":{ + "code":"HsmConfigurationAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is already an existing Amazon Redshift HSM configuration with the specified identifier.

" + }, + { + "shape":"HsmConfigurationQuotaExceededFault", + "error":{ + "code":"HsmConfigurationQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The quota for HSM configurations has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + } + ], + "documentation":"

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster\n to store and use database encryption keys in a Hardware Security Module (HSM). After\n creating the HSM configuration, you can specify it as a parameter when creating a cluster.\n The cluster will then store its encryption keys in the HSM.

\n

In addition to creating an HSM configuration, you must also create an HSM client certificate.\n For more information, go to\n Hardware Security Modules in the Amazon Redshift Management Guide.

" + }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteClusterMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"DeleteClusterResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"DeleteClusterResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"InvalidClusterStateFault", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + }, + { + "shape":"ClusterSnapshotAlreadyExistsFault", + "error":{ + "code":"ClusterSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The value specified as a snapshot identifier is already used by an existing snapshot.\n

" + }, + { + "shape":"ClusterSnapshotQuotaExceededFault", + "error":{ + "code":"ClusterSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in the user exceeding the allowed number of cluster snapshots.\n

" + } + ], + "documentation":"

\n Deletes a previously provisioned cluster. A successful response\n from the web service indicates that the request was received correctly. If a final cluster snapshot is requested\n the status of the cluster will be \"final-snapshot\" while the snapshot is being taken, then it's \"deleting\" once Amazon Redshift begins deleting the cluster. Use DescribeClusters \n to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteCluster\n &ClusterIdentifier=examplecluster2\n &SkipFinalClusterSnapshot=true\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T022400Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n \n \n 5439\n
examplecluster2.cobbanlpscsn.us-east-1.redshift.amazonaws.com
\n \n deleting\n 2\n 1\n true\n true\n dev\n sun:10:30-sun:11:00\n \n \n in-sync\n default.redshift-1.0\n \n \n 2013-01-23T00:11:32.804Z\n \n \n active\n default\n \n \n us-east-1a\n dw1.xlarge\n examplecluster2\n true\n masteruser\n \n \n \n f2e6b87e-6503-11e2-b343-393adc3f0a21\n \n\n " + }, + "DeleteClusterParameterGroup":{ + "name":"DeleteClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteClusterParameterGroupMessage", + "documentation":"

\n\n

" + }, + "errors":[ + { + "shape":"InvalidClusterParameterGroupStateFault", + "error":{ + "code":"InvalidClusterParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster parameter group action can not be completed because \n another task is in progress that involves the parameter group. \n Wait a few moments and try the operation again.\n

" + }, + { + "shape":"ClusterParameterGroupNotFoundFault", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + } + ], + "documentation":"

\n Deletes a specified Amazon Redshift parameter group. \n You cannot delete a parameter group if it is associated with a cluster. \n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteClusterParameterGroup\n &ParameterGroupName=parametergroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T015410Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n 29674ca0-40da-11e2-b679-dba6cf515770\n \n\n " + }, + "DeleteClusterSecurityGroup":{ + "name":"DeleteClusterSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteClusterSecurityGroupMessage", + "documentation":"

\n

" + }, + "errors":[ + { + "shape":"InvalidClusterSecurityGroupStateFault", + "error":{ + "code":"InvalidClusterSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster security group is not available.\n

" + }, + { + "shape":"ClusterSecurityGroupNotFoundFault", + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster security group name does not refer to an existing cluster security group.\n

" + } + ], + "documentation":"

\n Deletes an Amazon Redshift security group. \n

\n You cannot delete a security group that is associated with any clusters. You cannot\n delete the default security group.\n

\nFor information about managing security groups, go to\nAmazon Redshift Cluster Security Groups in the \nAmazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteClusterSecurityGroup\n &ClusterSecurityGroupName=securitygroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T015926Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n e54e05dc-40da-11e2-955f-313c36e9e01d\n \n\n " + }, + "DeleteClusterSnapshot":{ + "name":"DeleteClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteClusterSnapshotMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"DeleteClusterSnapshotResult", + "wrapper":true, + "documentation":"

Describes a snapshot.

", + "resultWrapper":"DeleteClusterSnapshotResult" + }, + "errors":[ + { + "shape":"InvalidClusterSnapshotStateFault", + "error":{ + "code":"InvalidClusterSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.\n

" + }, + { + "shape":"ClusterSnapshotNotFoundFault", + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

" + } + ], + "documentation":"

\n Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot. \n

\n

\n Unlike automated snapshots, manual snapshots are retained even after you \n delete your cluster. \n Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot \n explicitly to avoid getting charged.\n If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteClusterSnapshot\n &SnapshotIdentifier=snapshot-1234\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T005225Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n 2012-12-07T23:31:02.372Z\n 5439\n snapshot-1234\n deleted\n 2012-12-06T23:09:01.475Z\n manual\n 1.0\n us-east-1a\n examplecluster\n masteruser\n dw1.xlarge\n mydb\n 3\n \n \n \n 88a31de4-40d1-11e2-8a25-eb010998df4e\n \n\n " + }, + "DeleteClusterSubnetGroup":{ + "name":"DeleteClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterSubnetGroupMessage"}, + "errors":[ + { + "shape":"InvalidClusterSubnetGroupStateFault", + "error":{ + "code":"InvalidClusterSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group cannot be deleted because it is in use.\n

" + }, + { + "shape":"InvalidClusterSubnetStateFault", + "error":{ + "code":"InvalidClusterSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the subnet is invalid.

" + }, + { + "shape":"ClusterSubnetGroupNotFoundFault", + "error":{ + "code":"ClusterSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

" + } + ], + "documentation":"

\n Deletes the specified cluster subnet group.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteClusterSubnetGroup\n &ClusterSubnetGroupName=my-subnet-group-2\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130130/us-east-1/redshift/aws4_request\n &x-amz-date=20130130T154635Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n 3a63806b-6af4-11e2-b27b-4d850b1c672d\n \n\n " + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteEventSubscriptionMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon Redshift event notification subscription with the specified name does not exist.

" + }, + { + "shape":"InvalidSubscriptionStateFault", + "error":{ + "code":"InvalidSubscriptionStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.\n

" + } + ], + "documentation":"

\n Deletes an Amazon Redshift event notification subscription.\n

" + }, + "DeleteHsmClientCertificate":{ + "name":"DeleteHsmClientCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteHsmClientCertificateMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidHsmClientCertificateStateFault", + "error":{ + "code":"InvalidHsmClientCertificateStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified HSM client certificate is not in the available state, or it is still in\n use by one or more Amazon Redshift clusters.

" + }, + { + "shape":"HsmClientCertificateNotFoundFault", + "error":{ + "code":"HsmClientCertificateNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM client certificate with the specified identifier.

" + } + ], + "documentation":"

Deletes the specified HSM client certificate.

" + }, + "DeleteHsmConfiguration":{ + "name":"DeleteHsmConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteHsmConfigurationMessage", + "documentation":"

" + }, + "errors":[ + { + "shape":"InvalidHsmConfigurationStateFault", + "error":{ + "code":"InvalidHsmConfigurationStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified HSM configuration is not in the available state, or it is still in\n use by one or more Amazon Redshift clusters.

" + }, + { + "shape":"HsmConfigurationNotFoundFault", + "error":{ + "code":"HsmConfigurationNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM configuration with the specified identifier.

" + } + ], + "documentation":"

Deletes the specified Amazon Redshift HSM configuration.

" + }, + "DescribeClusterParameterGroups":{ + "name":"DescribeClusterParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeClusterParameterGroupsMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"ClusterParameterGroupsMessage", + "documentation":"

\n\t\tContains the output from the DescribeClusterParameterGroups action.\n

", + "resultWrapper":"DescribeClusterParameterGroupsResult" + }, + "errors":[ + { + "shape":"ClusterParameterGroupNotFoundFault", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + } + ], + "documentation":"

\n Returns a list of Amazon Redshift parameter groups, including parameter \n groups you created and the default parameter \n group. For each parameter group, the response \n includes the parameter group name, description, and parameter group family name. \n You can optionally specify a name \n to retrieve the description of \n a specific parameter group. \n

\n

\nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterParameterGroups\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T004002Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n\n \n \n \n \n redshift-1.0\n Default parameter group for redshift-1.0\n default.redshift-1.0\n \n \n redshift-1.0\n description my parameter group\n parametergroup1\n \n \n \n \n 6d28788b-64f5-11e2-b343-393adc3f0a21\n \n\n " + }, + "DescribeClusterParameters":{ + "name":"DescribeClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterParametersMessage"}, + "output":{ + "shape":"ClusterParameterGroupDetails", + "documentation":"

\n\t\tContains the output from the DescribeClusterParameters action.\n

", + "resultWrapper":"DescribeClusterParametersResult" + }, + "errors":[ + { + "shape":"ClusterParameterGroupNotFoundFault", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + } + ], + "documentation":"

\n Returns a detailed list of parameters contained within the specified Amazon Redshift \n parameter group. For each parameter the response includes information \n such as parameter name, description, \n data type, value, whether the parameter value is modifiable, and so on.\n

\n

You can specify source filter to retrieve parameters of only specific type.\n For example, to retrieve parameters that were modified by a user action such as from \n ModifyClusterParameterGroup, you can specify source equal to user.

\n

\nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterParameters\n &ParameterGroupName=parametergroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T010408Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n ISO, MDY\n string\n engine-default\n true\n Sets the display format for date and time values.\n datestyle\n \n \n 0\n integer\n engine-default\n true\n Sets the number of digits displayed for floating-point values\n -15-2\n extra_float_digits\n \n \n default\n string\n engine-default\n true\n This parameter applies a user-defined label to a group of queries that are run during the same session..\n query_group\n \n \n false\n boolean\n engine-default\n true\n require ssl for all databaseconnections\n true,false\n require_ssl\n \n \n $user, public\n string\n engine-default\n true\n Sets the schema search order for names that are not schema-qualified.\n search_path\n \n \n 0\n integer\n engine-default\n true\n Aborts any statement that takes over the specified number of milliseconds.\n statement_timeout\n \n \n [{"query_concurrency":5}]\n string\n engine-default\n true\n wlm json configuration\n wlm_json_configuration\n \n \n \n \n 2ba35df4-40d3-11e2-82cf-0b45b05c0221\n \n\n " + }, + "DescribeClusterSecurityGroups":{ + "name":"DescribeClusterSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeClusterSecurityGroupsMessage", + "documentation":"

???

" + }, + "output":{ + "shape":"ClusterSecurityGroupMessage", + "documentation":"

\n\t\tContains the output from the DescribeClusterSecurityGroups action.\n

", + "resultWrapper":"DescribeClusterSecurityGroupsResult" + }, + "errors":[ + { + "shape":"ClusterSecurityGroupNotFoundFault", + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster security group name does not refer to an existing cluster security group.\n

" + } + ], + "documentation":"

\n Returns information about Amazon Redshift security groups. \n If the name of a security group is specified, \n the response will contain only information about only that security group. \n

\n

\nFor information about managing security groups, go to\nAmazon Redshift Cluster Security Groups in the \nAmazon Redshift Management Guide.\n

\n \n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterSecurityGroups\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T010237Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n \n \n 0.0.0.0/0\n authorized\n \n \n default\n default\n \n \n \n \n my security group\n securitygroup1\n \n \n \n \n 947a8305-64f8-11e2-bec0-17624ad140dd\n \n\n " + }, + "DescribeClusterSnapshots":{ + "name":"DescribeClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeClusterSnapshotsMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"SnapshotMessage", + "documentation":"

\n\t\tContains the output from the DescribeClusterSnapshots action.\n

", + "resultWrapper":"DescribeClusterSnapshotsResult" + }, + "errors":[ + { + "shape":"ClusterSnapshotNotFoundFault", + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

" + } + ], + "documentation":"

\n Returns one or more snapshot objects, which contain metadata about your cluster snapshots.\n By default, this operation returns information about all snapshots of all clusters that are\n owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterSnapshots\n &ClusterIdentifier=examplecluster\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T011512Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 5439\n cm:examplecluster-2013-01-22-19-27-58\n available\n automated\n 1.0\n 2013-01-22T19:27:58.931Z\n 2\n dev\n 2013-01-22T19:23:59.368Z\n us-east-1c\n dw1.xlarge\n examplecluster\n adminuser\n \n \n 5439\n my-snapshot-123\n available\n manual\n 1.0\n 2013-01-23T01:09:03.149Z\n 2\n dev\n 2013-01-22T19:23:59.368Z\n us-east-1c\n dw1.xlarge\n examplecluster\n adminuser\n \n \n \n \n 56a9daf4-64fa-11e2-a8da-655adc216806\n \n\n " + }, + "DescribeClusterSubnetGroups":{ + "name":"DescribeClusterSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeClusterSubnetGroupsMessage", + "documentation":"

\n

" + }, + "output":{ + "shape":"ClusterSubnetGroupMessage", + "documentation":"

\n Contains the output from the \n DescribeClusterSubnetGroups action.\n

", + "resultWrapper":"DescribeClusterSubnetGroupsResult" + }, + "errors":[ + { + "shape":"ClusterSubnetGroupNotFoundFault", + "error":{ + "code":"ClusterSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

" + } + ], + "documentation":"

\n Returns one or more cluster subnet group objects, which contain metadata about your\n cluster subnet groups. By default, this operation returns information about\n all cluster subnet groups that are defined in you AWS account.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterSubnetGroups\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130130/us-east-1/redshift/aws4_request\n &x-amz-date=20130130T153938Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n vpc-5d917a30\n my subnet group\n my-subnet-group\n Complete\n \n \n Active\n subnet-71c5091c\n \n us-east-1a\n \n \n \n Active\n subnet-78de1215\n \n us-east-1a\n \n \n \n \n \n \n \n 42024b68-6af3-11e2-a726-6368a468fa67\n \n\n " + }, + "DescribeClusterVersions":{ + "name":"DescribeClusterVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterVersionsMessage"}, + "output":{ + "shape":"ClusterVersionsMessage", + "documentation":"

\n Contains the output from the DescribeClusterVersions action.\n

", + "resultWrapper":"DescribeClusterVersionsResult" + }, + "documentation":"

\n Returns descriptions of the available Amazon Redshift cluster versions. You can call this \n operation even before creating any clusters to learn more about the Amazon Redshift versions. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterVersions\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T230708Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n redshift-1.0\n Initial release of redshift\n 1.0\n \n \n \n \n d39cd5e5-40c2-11e2-8a25-eb010998df4e\n \n\n " + }, + "DescribeClusters":{ + "name":"DescribeClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeClustersMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"ClustersMessage", + "documentation":"

\n Contains the output from the DescribeClusters action.\n

", + "resultWrapper":"DescribeClustersResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + } + ], + "documentation":"

\n Returns properties of provisioned clusters including general cluster properties, cluster database properties,\n maintenance and backup properties, and security and access properties. This operation supports pagination. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n.\n

\n \n \n Describing All Clusters\n The following example shows a request that describes all clusters.\n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusters\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T000452Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n ****\n \n 1.0\n \n creating\n 2\n 1\n true\n false\n dev\n sun:10:30-sun:11:00\n \n \n in-sync\n default.redshift-1.0\n \n \n \n \n active\n default\n \n \n us-east-1a\n dw1.xlarge\n examplecluster\n true\n masteruser\n \n \n \n \n 837d45d6-64f0-11e2-b07c-f7fbdd006c67\n \n\n \n " + }, + "DescribeDefaultClusterParameters":{ + "name":"DescribeDefaultClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDefaultClusterParametersMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"DescribeDefaultClusterParametersResult", + "wrapper":true, + "documentation":"

Describes the default cluster parameters for a parameter group family.

", + "resultWrapper":"DescribeDefaultClusterParametersResult" + }, + "documentation":"

\n Returns a list of parameter settings for the specified parameter group family.\n

\n

\nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeDefaultClusterParameters\n &ParameterGroupFamily=redshift-1.0\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T231708Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n redshift-1.0\n \n \n ISO, MDY\n string\n engine-default\n true\n Sets the display format for date and time values.\n datestyle\n \n \n 0\n integer\n engine-default\n true\n Sets the number of digits displayed for floating-point values\n -15-2\n extra_float_digits\n \n \n default\n string\n engine-default\n true\n This parameter applies a user-defined label to a group of queries that are run during the same session..\n query_group\n \n \n false\n boolean\n engine-default\n true\n require ssl for all databaseconnections\n true,false\n require_ssl\n \n \n $user, public\n string\n engine-default\n true\n Sets the schema search order for names that are not schema-qualified.\n search_path\n \n \n 0\n integer\n engine-default\n true\n Aborts any statement that takes over the specified number of milliseconds.\n statement_timeout\n \n \n [{"query_concurrency":5}]\n string\n engine-default\n true\n wlm json configuration\n wlm_json_configuration\n \n \n \n \n \n 396df00b-40c4-11e2-82cf-0b45b05c0221\n \n\n " + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventCategoriesMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"EventCategoriesMessage", + "documentation":"

\n \n

", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

Displays a list of event categories for all event source types, or for a\n specified source type. For a list of the event categories and source types,\n go to Amazon Redshift Event Notifications.

" + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventSubscriptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"EventSubscriptionsMessage", + "documentation":"

", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon Redshift event notification subscription with the specified name does not exist.

" + } + ], + "documentation":"

\n Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account.\n If you specify a subscription name, lists the description for that subscription.\n

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventsMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"EventsMessage", + "documentation":"

\n\t\tContains the output from the DescribeEvents action.\n

", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

\n Returns events related to clusters, security groups, snapshots, and parameter\n groups for the past 14 days. Events specific to a particular cluster, security group,\n snapshot or parameter group can be obtained by providing the name as a parameter.\n By default, the past hour of events are returned.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeEvents\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T232427Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n Cluster security group securitygroup1 has been updated. Changes need to be applied to all clusters using this cluster security group.\n cluster-security-group\n 2012-12-07T23:05:02.660Z\n securitygroup1\n \n \n \n \n 3eeb9efe-40c5-11e2-816a-1bba29fad1f5\n \n\n " + }, + "DescribeHsmClientCertificates":{ + "name":"DescribeHsmClientCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeHsmClientCertificatesMessage", + "documentation":"

" + }, + "output":{ + "shape":"HsmClientCertificateMessage", + "documentation":"

", + "resultWrapper":"DescribeHsmClientCertificatesResult" + }, + "errors":[ + { + "shape":"HsmClientCertificateNotFoundFault", + "error":{ + "code":"HsmClientCertificateNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM client certificate with the specified identifier.

" + } + ], + "documentation":"

Returns information about the specified HSM client certificate. If no certificate ID is specified,\n returns information about all the HSM certificates owned by your AWS customer account.

" + }, + "DescribeHsmConfigurations":{ + "name":"DescribeHsmConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeHsmConfigurationsMessage", + "documentation":"

" + }, + "output":{ + "shape":"HsmConfigurationMessage", + "documentation":"

", + "resultWrapper":"DescribeHsmConfigurationsResult" + }, + "errors":[ + { + "shape":"HsmConfigurationNotFoundFault", + "error":{ + "code":"HsmConfigurationNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM configuration with the specified identifier.

" + } + ], + "documentation":"

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is\n specified, returns information about all the HSM configurations owned by your AWS customer account.

" + }, + "DescribeLoggingStatus":{ + "name":"DescribeLoggingStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeLoggingStatusMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"LoggingStatus", + "documentation":"

Describes the status of logging for a cluster.

", + "resultWrapper":"DescribeLoggingStatusResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + } + ], + "documentation":"

Describes whether information, such as queries and connection attempts,\n is being logged for the specified Amazon Redshift cluster.

" + }, + "DescribeOrderableClusterOptions":{ + "name":"DescribeOrderableClusterOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOrderableClusterOptionsMessage", + "documentation":"

" + }, + "output":{ + "shape":"OrderableClusterOptionsMessage", + "documentation":"

\n Contains the output from the DescribeOrderableClusterOptions action. \n

", + "resultWrapper":"DescribeOrderableClusterOptionsResult" + }, + "documentation":"

Returns a list of orderable cluster options. Before you create a \n new cluster you can use this operation to find what options are \n available, such as the EC2 Availability Zones (AZ) in the specific \n AWS region that you can specify, \n and the node types you can request. The node types differ by available \n storage, memory, CPU and price. With the cost involved you might want to \n obtain a list of cluster options in the specific region and specify values \n when creating a cluster. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeOrderableClusterOptions\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T225314Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n multi-node\n dw1.8xlarge\n \n \n us-east-1a\n \n \n us-east-1c\n \n \n us-east-1d\n \n \n \n \n 1.0\n multi-node\n dw1.xlarge\n \n \n us-east-1a\n \n \n us-east-1c\n \n \n us-east-1d\n \n \n \n \n 1.0\n single-node\n dw1.xlarge\n \n \n us-east-1a\n \n \n us-east-1c\n \n \n us-east-1d\n \n \n \n \n \n \n e37414cc-40c0-11e2-b6a0-df98b1a86860\n \n\n " + }, + "DescribeReservedNodeOfferings":{ + "name":"DescribeReservedNodeOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedNodeOfferingsMessage", + "documentation":"

to be provided.

" + }, + "output":{ + "shape":"ReservedNodeOfferingsMessage", + "documentation":"

\n Contains the output from the DescribeReservedNodeOfferings action. \n

", + "resultWrapper":"DescribeReservedNodeOfferingsResult" + }, + "errors":[ + { + "shape":"ReservedNodeOfferingNotFoundFault", + "error":{ + "code":"ReservedNodeOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Specified offering does not exist.\n

" + } + ], + "documentation":"

\n Returns a list of the\n available reserved node offerings by Amazon Redshift with their descriptions including \n the node type, the fixed and recurring costs of reserving the node and duration the node will \n be reserved for you. These descriptions help you \n determine which reserve node offering you want to purchase. You then use the unique offering ID \n in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your \n Amazon Redshift cluster.\n

\n

\n \nFor more information about managing parameter groups, go to \nPurchasing Reserved Nodes \nin the Amazon Redshift Management Guide.\n \n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeReservedNodeOfferings\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130117/us-east-1/redshift/aws4_request\n &x-amz-date=20130117T232351Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n Heavy Utilization\n 94608000\n \n \n Hourly\n 0.21\n \n \n 12452.0\n 3a98bf7d-979a-49cc-b568-18f24315baf0\n 0.0\n dw1.8xlarge\n \n \n Heavy Utilization\n 31536000\n \n \n Hourly\n 0.09\n \n \n 1815.0\n d586503b-289f-408b-955b-9c95005d6908\n 0.0\n dw1.xlarge\n \n \n \n f4a07e06-60fc-11e2-95d9-658e9466d117\n \n\n " + }, + "DescribeReservedNodes":{ + "name":"DescribeReservedNodes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedNodesMessage", + "documentation":"

\n

" + }, + "output":{ + "shape":"ReservedNodesMessage", + "documentation":"

Contains the output from the DescribeReservedNodes action.

", + "resultWrapper":"DescribeReservedNodesResult" + }, + "errors":[ + { + "shape":"ReservedNodeNotFoundFault", + "error":{ + "code":"ReservedNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified reserved compute node not found.\n

" + } + ], + "documentation":"

\n Returns the descriptions of the reserved nodes.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeReservedNodes\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130125/us-east-1/redshift/aws4_request\n &x-amz-date=20130125T202355Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 2013-01-22T18:46:48.600Z\n Medium Utilization\n 31536000\n \n 800.0\n 0.158\n payment-pending\n dw1.xlarge\n 1\n 4357912c-9266-469d-beb0-0f1b775e1bc9\n \n \n 2013-01-22T20:09:16.630Z\n Heavy Utilization\n 94608000\n \n \n Hourly\n 0.21\n \n \n 12452.0\n 0.0\n payment-pending\n dw1.8xlarge\n 2\n 93bbbca2-e88c-4b8b-a600-b64eaabf18a3\n \n \n 2013-01-23T21:49:32.517Z\n Medium Utilization\n 31536000\n \n 800.0\n 0.158\n payment-pending\n dw1.xlarge\n 1\n bbcd9749-f2ea-4d01-9b1b-b576f618eb4e\n \n \n \n \n 24dc90c8-672d-11e2-b2e1-8f41f0379151\n \n\n " + }, + "DescribeResize":{ + "name":"DescribeResize", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeResizeMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"ResizeProgressMessage", + "documentation":"

Describes the result of a cluster resize operation.

", + "resultWrapper":"DescribeResizeResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"ResizeNotFoundFault", + "error":{ + "code":"ResizeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

A resize operation for the specified cluster is not found.

" + } + ], + "documentation":"

\n Returns information about the last resize operation for the specified cluster. \n If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned.\n If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until\n the next resize.\n

\n

\n A resize operation can be requested using \n ModifyCluster and specifying a different number or type of nodes for the cluster.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeResize\n &ClusterIdentifier=examplecluster\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T232427Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n multi-node\n SUCCEEDED\n 6.5263\n 66922\n 0\n \n users\n venue\n sales\n listing\n event\n date\n category\n \n 10254\n dw1.xlarge\n 2\n \n \n a6d59c61-a162-11e2-b2bc-fb54c9d11e09\n \n\n " + }, + "DisableLogging":{ + "name":"DisableLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DisableLoggingMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"LoggingStatus", + "documentation":"

Describes the status of logging for a cluster.

", + "resultWrapper":"DisableLoggingResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + } + ], + "documentation":"

Stops logging information, such as queries and connection attempts,\n for the specified Amazon Redshift cluster.

" + }, + "DisableSnapshotCopy":{ + "name":"DisableSnapshotCopy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DisableSnapshotCopyMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"DisableSnapshotCopyResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"DisableSnapshotCopyResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"SnapshotCopyAlreadyDisabledFault", + "error":{ + "code":"SnapshotCopyAlreadyDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster already has cross-region snapshot copy disabled.\n

" + }, + { + "shape":"InvalidClusterStateFault", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + }, + { + "shape":"UnauthorizedOperation", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + } + ], + "documentation":"

Disables the automatic copying of snapshots from one region to another region for a specified cluster.

" + }, + "EnableLogging":{ + "name":"EnableLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"EnableLoggingMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"LoggingStatus", + "documentation":"

Describes the status of logging for a cluster.

", + "resultWrapper":"EnableLoggingResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"BucketNotFoundFault", + "error":{ + "code":"BucketNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Could not find the specified S3 bucket.\n

" + }, + { + "shape":"InsufficientS3BucketPolicyFault", + "error":{ + "code":"InsufficientS3BucketPolicyFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster does not have read bucket or put object permissions\n on the S3 bucket specified when enabling logging.\n

" + }, + { + "shape":"InvalidS3KeyPrefixFault", + "error":{ + "code":"InvalidS3KeyPrefixFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The string specified for the logging S3 key prefix does not comply with\n the documented constraints.\n

" + }, + { + "shape":"InvalidS3BucketNameFault", + "error":{ + "code":"InvalidS3BucketNameFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.

" + } + ], + "documentation":"

Starts logging information, such as queries and connection attempts,\n for the specified Amazon Redshift cluster.

" + }, + "EnableSnapshotCopy":{ + "name":"EnableSnapshotCopy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"EnableSnapshotCopyMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"EnableSnapshotCopyResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"EnableSnapshotCopyResult" + }, + "errors":[ + { + "shape":"IncompatibleOrderableOptions", + "error":{ + "code":"IncompatibleOrderableOptions", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified options are incompatible.\n

" + }, + { + "shape":"InvalidClusterStateFault", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + }, + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"CopyToRegionDisabledFault", + "error":{ + "code":"CopyToRegionDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Cross-region snapshot copy was temporarily disabled. Try your request again.\n

" + }, + { + "shape":"SnapshotCopyAlreadyEnabledFault", + "error":{ + "code":"SnapshotCopyAlreadyEnabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster already has cross-region snapshot copy enabled.\n

" + }, + { + "shape":"UnknownSnapshotCopyRegionFault", + "error":{ + "code":"UnknownSnapshotCopyRegionFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified region is incorrect or does not exist.\n

" + }, + { + "shape":"UnauthorizedOperation", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + } + ], + "documentation":"

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

" + }, + "ModifyCluster":{ + "name":"ModifyCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyClusterMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyClusterResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"ModifyClusterResult" + }, + "errors":[ + { + "shape":"InvalidClusterStateFault", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + }, + { + "shape":"InvalidClusterSecurityGroupStateFault", + "error":{ + "code":"InvalidClusterSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster security group is not available.\n

" + }, + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"NumberOfNodesQuotaExceededFault", + "error":{ + "code":"NumberOfNodesQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The operation would exceed the number of nodes allotted to the account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n

" + }, + { + "shape":"ClusterSecurityGroupNotFoundFault", + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster security group name does not refer to an existing cluster security group.\n

" + }, + { + "shape":"ClusterParameterGroupNotFoundFault", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + }, + { + "shape":"InsufficientClusterCapacityFault", + "error":{ + "code":"InsufficientClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The number of nodes specified exceeds the allotted capacity of the cluster.\n

" + }, + { + "shape":"UnsupportedOptionFault", + "error":{ + "code":"UnsupportedOptionFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A request option was specified that is not supported. \n

" + }, + { + "shape":"UnauthorizedOperation", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + }, + { + "shape":"HsmClientCertificateNotFoundFault", + "error":{ + "code":"HsmClientCertificateNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM client certificate with the specified identifier.

" + }, + { + "shape":"HsmConfigurationNotFoundFault", + "error":{ + "code":"HsmConfigurationNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM configuration with the specified identifier.

" + }, + { + "shape":"ClusterAlreadyExistsFault", + "error":{ + "code":"ClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The account already has a cluster with the given identifier.\n

" + } + ], + "documentation":"

\n Modifies the settings for a cluster. \n For example, you can add another security or parameter group, \n update the preferred maintenance window, or change the master user password. \n Resetting a cluster password or modifying the security groups associated \n with a cluster do not need a reboot. However, modifying a parameter group \n requires a reboot for parameters to take effect. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n\n

\n

You can also change node type and the number of nodes to scale up or down the cluster. \n When resizing a cluster, you must specify\n both the number of nodes and the node type even if one of the parameters does \n not change. If you specify\n the same number of nodes and node type that are already configured for the cluster, \n an error is returned.

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=ModifyCluster\n &AllowVersionUpgrade=true\n &AutomatedSnapshotRetentionPeriod=2\n &ClusterIdentifier=examplecluster\n &ClusterParameterGroupName=parametergroup1\n &PreferredMaintenanceWindow=wed:07:30-wed:08:00\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T022911Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n \n \n 5439\n
examplecluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com
\n \n available\n 2\n 2\n true\n false\n dev\n wed:07:30-wed:08:00\n \n \n applying\n parametergroup1\n \n \n 2013-01-22T19:23:59.368Z\n \n \n active\n default\n \n \n us-east-1c\n dw1.xlarge\n examplecluster\n true\n adminuser\n \n \n \n acbc43d5-6504-11e2-bea9-49e0ce183f07\n \n\n " + }, + "ModifyClusterParameterGroup":{ + "name":"ModifyClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyClusterParameterGroupMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"ClusterParameterGroupNameMessage", + "documentation":"

\n\t\tContains the output from the \n ModifyClusterParameterGroup and ResetClusterParameterGroup actions and\n indicate the parameter group involved and the status of the operation on the \n parameter group.\n

", + "resultWrapper":"ModifyClusterParameterGroupResult" + }, + "errors":[ + { + "shape":"ClusterParameterGroupNotFoundFault", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + }, + { + "shape":"InvalidClusterParameterGroupStateFault", + "error":{ + "code":"InvalidClusterParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster parameter group action can not be completed because \n another task is in progress that involves the parameter group. \n Wait a few moments and try the operation again.\n

" + } + ], + "documentation":"

\n Modifies the parameters of a parameter group. \n

\n

\nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n

\n\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=ModifyClusterParameterGroup\n &ParameterGroupName=parametergroup1\n &Parameters.member.1.ParameterName=extra_float_digits\n &Parameters.member.1.ParameterValue=2\n &Parameters.member.2.ParameterName=wlm_json_configuration\n &Parameters.member.2.ParameterValue=[{\"user_group\":[\"example_user_group1\"],\"query_group\":[\"example_query_group1\"],\"query_concurrency\":7},{\"query_concurrency\":5}]\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T022525Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.\n parametergroup1\n \n \n 86e64043-40de-11e2-8a25-eb010998df4e\n \n\n " + }, + "ModifyClusterSubnetGroup":{ + "name":"ModifyClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyClusterSubnetGroupMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"ModifyClusterSubnetGroupResult", + "wrapper":true, + "documentation":"

Describes a subnet group.

", + "resultWrapper":"ModifyClusterSubnetGroupResult" + }, + "errors":[ + { + "shape":"ClusterSubnetGroupNotFoundFault", + "error":{ + "code":"ClusterSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

" + }, + { + "shape":"ClusterSubnetQuotaExceededFault", + "error":{ + "code":"ClusterSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + { + "shape":"SubnetAlreadyInUse", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n A specified subnet is already in use by another cluster.\n

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

" + }, + { + "shape":"UnauthorizedOperation", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + } + ], + "documentation":"

\n Modifies a cluster subnet group to include the specified list of VPC subnets. \n The operation replaces the existing list of subnets with the new list of subnets. \n

" + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyEventSubscriptionMessage", + "documentation":"

" + }, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "wrapper":true, + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon Redshift event notification subscription with the specified name does not exist.

" + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

" + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the specified Amazon SNS topic.

" + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

" + }, + { + "shape":"SubscriptionEventIdNotFoundFault", + "error":{ + "code":"SubscriptionEventIdNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon Redshift event with the specified event ID does not exist.

" + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The value specified for the event category was not one of the allowed values, or\n it specified a category that does not apply to the specified source type. The allowed\n values are Configuration, Management, Monitoring, and Security.

" + }, + { + "shape":"SubscriptionSeverityNotFoundFault", + "error":{ + "code":"SubscriptionSeverityNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The value specified for the event severity was not one of the allowed values, or\n it specified a severity that does not apply to the specified source type. The allowed\n values are ERROR and INFO.

" + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon Redshift event source could not be found.

" + }, + { + "shape":"InvalidSubscriptionStateFault", + "error":{ + "code":"InvalidSubscriptionStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.\n

" + } + ], + "documentation":"

\n Modifies an existing Amazon Redshift event notification subscription.\n

" + }, + "ModifySnapshotCopyRetentionPeriod":{ + "name":"ModifySnapshotCopyRetentionPeriod", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifySnapshotCopyRetentionPeriodMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"ModifySnapshotCopyRetentionPeriodResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"ModifySnapshotCopyRetentionPeriodResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"SnapshotCopyDisabledFault", + "error":{ + "code":"SnapshotCopyDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Cross-region snapshot copy was temporarily disabled. Try your request again.\n

" + }, + { + "shape":"UnauthorizedOperation", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + }, + { + "shape":"InvalidClusterStateFault", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + } + ], + "documentation":"

\n Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.\n

" + }, + "PurchaseReservedNodeOffering":{ + "name":"PurchaseReservedNodeOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PurchaseReservedNodeOfferingMessage", + "documentation":"

" + }, + "output":{ + "shape":"PurchaseReservedNodeOfferingResult", + "wrapper":true, + "documentation":"

\n Describes a reserved node.\n

", + "resultWrapper":"PurchaseReservedNodeOfferingResult" + }, + "errors":[ + { + "shape":"ReservedNodeOfferingNotFoundFault", + "error":{ + "code":"ReservedNodeOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Specified offering does not exist.\n

" + }, + { + "shape":"ReservedNodeAlreadyExistsFault", + "error":{ + "code":"ReservedNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n User already has a reservation with the given identifier.\n

" + }, + { + "shape":"ReservedNodeQuotaExceededFault", + "error":{ + "code":"ReservedNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Request would exceed the user's compute node quota. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + } + ], + "documentation":"

\n Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings.\n You can purchase one of the offerings. You can call the\n DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this \n API by providing a specific reserved node offering and the number of nodes you want to reserve.\n

\n

\n \nFor more information about managing parameter groups, go to \nPurchasing Reserved Nodes \nin the Amazon Redshift Management Guide.\n \n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=PurchaseReservedNodeOffering\n &ReservedNodeOfferingId=3a98bf7d-979a-49cc-b568-18f24315baf0\n &NodeCount=2\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130117/us-east-1/redshift/aws4_request\n &x-amz-date=20130117T232351Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n 2013-01-18T21:42:44.402Z\n Heavy Utilization\n 94608000\n \n \n Hourly\n 0.21\n \n \n 12452.0\n 0.0\n payment-pending\n dw1.8xlarge\n 2\n 1ba8e2e3-dacf-48d9-841f-cc675182a8a6\n \n \n \n fcb117cc-61b7-11e2-b6e9-87e586e4ca38\n \n\n " + }, + "RebootCluster":{ + "name":"RebootCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RebootClusterMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"RebootClusterResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"RebootClusterResult" + }, + "errors":[ + { + "shape":"InvalidClusterStateFault", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + }, + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + } + ], + "documentation":"

\n Reboots a cluster. \n This action is taken as soon as possible. It results in a momentary outage to the cluster,\n during which the cluster status is set to rebooting. A cluster event is created\n when the reboot is completed. \n Any pending cluster modifications (see ModifyCluster) are applied at this reboot.\n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=RebootCluster\n &ClusterIdentifier=examplecluster\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T021951Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n \n \n 5439\n
examplecluster.cobaosmlqshn.us-east-1.redshift.amazonaws.com
\n \n rebooting\n 2\n 1\n true\n false\n dev\n sun:06:30-sun:07:00\n \n \n in-sync\n default.redshift-1.0\n \n \n 2013-01-22T19:23:59.368Z\n \n \n active\n default\n \n \n us-east-1c\n dw1.xlarge\n examplecluster\n true\n adminuser\n \n \n \n 5edee79e-6503-11e2-9e70-918437dd236d\n \n\n " + }, + "ResetClusterParameterGroup":{ + "name":"ResetClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ResetClusterParameterGroupMessage", + "documentation":"

\n\n

" + }, + "output":{ + "shape":"ClusterParameterGroupNameMessage", + "documentation":"

\n\t\tContains the output from the \n ModifyClusterParameterGroup and ResetClusterParameterGroup actions and\n indicate the parameter group involved and the status of the operation on the \n parameter group.\n

", + "resultWrapper":"ResetClusterParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidClusterParameterGroupStateFault", + "error":{ + "code":"InvalidClusterParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster parameter group action can not be completed because \n another task is in progress that involves the parameter group. \n Wait a few moments and try the operation again.\n

" + }, + { + "shape":"ClusterParameterGroupNotFoundFault", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + } + ], + "documentation":"

\n Sets one or more parameters of the specified parameter group to their default values and sets the \n source values of the parameters to \"engine-default\". \n To reset the entire parameter group specify the ResetAllParameters parameter. \n For parameter changes to take effect you must reboot any associated clusters.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=ResetClusterParameterGroup\n &ParameterGroupName=parametergroup1\n &Parameters.member.1.ParameterName=extra_float_digits\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T020847Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.\n parametergroup1\n \n \n 625d23c1-40dc-11e2-8a25-eb010998df4e\n \n\n " + }, + "RestoreFromClusterSnapshot":{ + "name":"RestoreFromClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreFromClusterSnapshotMessage", + "documentation":"

" + }, + "output":{ + "shape":"RestoreFromClusterSnapshotResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"RestoreFromClusterSnapshotResult" + }, + "errors":[ + { + "shape":"AccessToSnapshotDeniedFault", + "error":{ + "code":"AccessToSnapshotDenied", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The owner of the specified snapshot has not authorized your account to access the snapshot.\n

" + }, + { + "shape":"ClusterAlreadyExistsFault", + "error":{ + "code":"ClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The account already has a cluster with the given identifier.\n

" + }, + { + "shape":"ClusterSnapshotNotFoundFault", + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

" + }, + { + "shape":"ClusterQuotaExceededFault", + "error":{ + "code":"ClusterQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would exceed the allowed number of cluster instances for this account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + { + "shape":"InsufficientClusterCapacityFault", + "error":{ + "code":"InsufficientClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The number of nodes specified exceeds the allotted capacity of the cluster.\n

" + }, + { + "shape":"InvalidClusterSnapshotStateFault", + "error":{ + "code":"InvalidClusterSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.\n

" + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestore", + "httpStatusCode":406, + "senderFault":true + }, + "exception":true, + "documentation":"

The restore is invalid.

" + }, + { + "shape":"NumberOfNodesQuotaExceededFault", + "error":{ + "code":"NumberOfNodesQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The operation would exceed the number of nodes allotted to the account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n

" + }, + { + "shape":"NumberOfNodesPerClusterLimitExceededFault", + "error":{ + "code":"NumberOfNodesPerClusterLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The operation would exceed the number of nodes allowed for a cluster.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group does not cover all Availability Zones.\n

" + }, + { + "shape":"InvalidClusterSubnetGroupStateFault", + "error":{ + "code":"InvalidClusterSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group cannot be deleted because it is in use.\n

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

" + }, + { + "shape":"ClusterSubnetGroupNotFoundFault", + "error":{ + "code":"ClusterSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

" + }, + { + "shape":"UnauthorizedOperation", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + }, + { + "shape":"HsmClientCertificateNotFoundFault", + "error":{ + "code":"HsmClientCertificateNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM client certificate with the specified identifier.

" + }, + { + "shape":"HsmConfigurationNotFoundFault", + "error":{ + "code":"HsmConfigurationNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM configuration with the specified identifier.

" + }, + { + "shape":"InvalidElasticIpFault", + "error":{ + "code":"InvalidElasticIpFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The Elastic IP (EIP) is invalid or cannot be found.

" + }, + { + "shape":"ClusterParameterGroupNotFoundFault", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + }, + { + "shape":"ClusterSecurityGroupNotFoundFault", + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster security group name does not refer to an existing cluster security group.\n

" + } + ], + "documentation":"

\n Creates a new cluster from a snapshot. Amazon Redshift creates the resulting cluster \n with the same configuration as the original cluster from which the snapshot was created, \n except that the new cluster\n is created with the default cluster security and parameter group. \n \n After Amazon Redshift creates the cluster you can use the ModifyCluster \n API to associate a different security group and different parameter group with the\n restored cluster.\n

\n

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster \n restored.\n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=RestoreFromClusterSnapshot\n &ClusterIdentifier=examplecluster-restored\n &SnapshotIdentifier=cm:examplecluster-2013-01-22-19-27-58\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T023350Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n \n creating\n 2\n 1\n true\n false\n dev\n sun:06:30-sun:07:00\n \n \n in-sync\n default.redshift-1.0\n \n \n \n \n active\n default\n \n \n dw1.xlarge\n examplecluster-restored\n true\n adminuser\n \n \n \n 52a9aee8-6505-11e2-bec0-17624ad140dd\n \n\n " + }, + "RevokeClusterSecurityGroupIngress":{ + "name":"RevokeClusterSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RevokeClusterSecurityGroupIngressMessage", + "documentation":"

\n ???\n

" + }, + "output":{ + "shape":"RevokeClusterSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Describes a security group.

", + "resultWrapper":"RevokeClusterSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"ClusterSecurityGroupNotFoundFault", + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster security group name does not refer to an existing cluster security group.\n

" + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified CIDR IP range or EC2 security group is not authorized\n for the specified cluster security group.\n

" + }, + { + "shape":"InvalidClusterSecurityGroupStateFault", + "error":{ + "code":"InvalidClusterSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster security group is not available.\n

" + } + ], + "documentation":"

\n Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or \n Amazon EC2 security group. To add\n an ingress rule, see AuthorizeClusterSecurityGroupIngress. \n \nFor information about managing security groups, go to\nAmazon Redshift Cluster Security Groups in the \nAmazon Redshift Management Guide.\n\n

\n\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=RevokeClusterSecurityGroupIngress\n &ClusterSecurityGroupName=securitygroup1\n &CIDRIP=192.168.40.3/32\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T021606Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n my security group\n securitygroup1\n \n \n \n d8eff363-6502-11e2-a8da-655adc216806\n \n\n " + }, + "RevokeSnapshotAccess":{ + "name":"RevokeSnapshotAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RevokeSnapshotAccessMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"RevokeSnapshotAccessResult", + "wrapper":true, + "documentation":"

Describes a snapshot.

", + "resultWrapper":"RevokeSnapshotAccessResult" + }, + "errors":[ + { + "shape":"AccessToSnapshotDeniedFault", + "error":{ + "code":"AccessToSnapshotDenied", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The owner of the specified snapshot has not authorized your account to access the snapshot.\n

" + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified CIDR IP range or EC2 security group is not authorized\n for the specified cluster security group.\n

" + }, + { + "shape":"ClusterSnapshotNotFoundFault", + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

" + } + ], + "documentation":"

\n Removes the ability of the specified AWS customer account to restore the specified snapshot.\n If the account is currently restoring the snapshot, the restore will run to completion.\n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

" + }, + "RotateEncryptionKey":{ + "name":"RotateEncryptionKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RotateEncryptionKeyMessage", + "documentation":"

\n \n

" + }, + "output":{ + "shape":"RotateEncryptionKeyResult", + "wrapper":true, + "documentation":"

Describes a cluster.

", + "resultWrapper":"RotateEncryptionKeyResult" + }, + "errors":[ + { + "shape":"ClusterNotFoundFault", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + { + "shape":"InvalidClusterStateFault", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + } + ], + "documentation":"

\n Rotates the encryption keys for a cluster.\n

" + } + }, + "shapes":{ + "AccessToSnapshotDeniedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AccessToSnapshotDenied", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The owner of the specified snapshot has not authorized your account to access the snapshot.\n

" + }, + "AccountWithRestoreAccess":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"

\n The identifier of an AWS customer account authorized to restore a snapshot. \n

" + } + }, + "documentation":"

\n Describes an AWS customer account authorized to restore a snapshot. \n

" + }, + "AccountsWithRestoreAccessList":{ + "type":"list", + "member":{ + "shape":"AccountWithRestoreAccess", + "locationName":"AccountWithRestoreAccess" + } + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.\n

" + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified CIDR IP range or EC2 security group is not authorized\n for the specified cluster security group.\n

" + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The authorization quota for the cluster security group has been reached.\n

" + }, + "AuthorizeClusterSecurityGroupIngressMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name of the security group to which the ingress rule is added.\n

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

\n The IP range to be added the Amazon Redshift security group.\n

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

\n The EC2 security group to be added the Amazon Redshift security group.\n

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

\n The AWS account number of the owner of the security group\n specified by the EC2SecurityGroupName parameter.\n The AWS Access Key ID is not an acceptable value.\n

\n

\n Example: 111122223333\n

" + } + }, + "documentation":"

\n ???\n

" + }, + "AuthorizeSnapshotAccessMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the snapshot the account is authorized to restore.\n

" + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

" + }, + "AccountWithRestoreAccess":{ + "shape":"String", + "documentation":"

\n The identifier of the AWS customer account authorized to restore the specified snapshot.\n

" + } + }, + "documentation":"

\n \n

" + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

\n The name of the availability zone.\n

" + } + }, + "wrapper":true, + "documentation":"

\n Describes an availability zone. \n

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "BucketNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"BucketNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Could not find the specified S3 bucket.\n

" + }, + "Cluster":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of the cluster.\n

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

\n The node type for the nodes in the cluster.\n

" + }, + "ClusterStatus":{ + "shape":"String", + "documentation":"

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, renaming, and resizing.\n

" + }, + "ModifyStatus":{ + "shape":"String", + "documentation":"

The status of a modify operation, if any, initiated for the cluster.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

" + }, + "DBName":{ + "shape":"String", + "documentation":"

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

\n The connection endpoint.\n

" + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

\n The date and time that the cluster was created.\n

" + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"

\n The number of days that automatic cluster snapshots are retained.\n

" + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroupMembershipList", + "documentation":"

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

" + }, + "ClusterParameterGroups":{ + "shape":"ClusterParameterGroupStatusList", + "documentation":"

\n The list of cluster parameter groups that are associated with this cluster.\n

" + }, + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

\n The name of the Availability Zone in which the cluster is located.\n

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

" + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

" + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

" + }, + "AllowVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

" + }, + "NumberOfNodes":{ + "shape":"Integer", + "documentation":"

\n The number of compute nodes in the cluster.\n

" + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

If true, the cluster can be accessed from a public network.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

If true, data in the cluster is encrypted at rest.

" + }, + "RestoreStatus":{ + "shape":"RestoreStatus", + "documentation":"

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

" + }, + "HsmStatus":{ + "shape":"HsmStatus", + "documentation":"

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

" + }, + "ClusterSnapshotCopyStatus":{ + "shape":"ClusterSnapshotCopyStatus", + "documentation":"

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

" + }, + "ClusterPublicKey":{ + "shape":"String", + "documentation":"

The public key for the cluster.

" + }, + "ClusterNodes":{ + "shape":"ClusterNodesList", + "documentation":"

The nodes in a cluster.

" + }, + "ElasticIpStatus":{ + "shape":"ElasticIpStatus", + "documentation":"

Describes the status of the elastic IP (EIP) address.

" + }, + "ClusterRevisionNumber":{ + "shape":"String", + "documentation":"

The specific revision number of the database in the cluster.

" + } + }, + "wrapper":true, + "documentation":"

Describes a cluster.

" + }, + "ClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The account already has a cluster with the given identifier.\n

" + }, + "ClusterList":{ + "type":"list", + "member":{ + "shape":"Cluster", + "locationName":"Cluster" + } + }, + "ClusterNode":{ + "type":"structure", + "members":{ + "NodeRole":{ + "shape":"String", + "documentation":"

Whether the node is a leader node or a compute node.

" + }, + "PrivateIPAddress":{ + "shape":"String", + "documentation":"

The private IP address of a node within a cluster.

" + }, + "PublicIPAddress":{ + "shape":"String", + "documentation":"

The public IP address of a node within a cluster.

" + } + }, + "documentation":"

The identifier of a node in a cluster. -->

" + }, + "ClusterNodesList":{ + "type":"list", + "member":{"shape":"ClusterNode"} + }, + "ClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

" + }, + "ClusterParameterGroup":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group.\n

" + }, + "ParameterGroupFamily":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group family that\n this cluster parameter group is compatible with.\n

" + }, + "Description":{ + "shape":"String", + "documentation":"

\n The description of the parameter group.\n

" + } + }, + "wrapper":true, + "documentation":"

Describes a parameter group.

" + }, + "ClusterParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n A cluster parameter group with the same name already exists.\n

" + }, + "ClusterParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

\n A list of Parameter instances. Each instance lists the parameters of one cluster parameter\n group.\n

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + } + }, + "documentation":"

\n\t\tContains the output from the DescribeClusterParameters action.\n

" + }, + "ClusterParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group.\n

" + }, + "ParameterGroupStatus":{ + "shape":"String", + "documentation":"

\n The status of the parameter group. For example, if you made\n a change to a parameter group name-value pair, then the change could be pending\n a reboot of an associated cluster.\n

" + } + }, + "documentation":"

\n\t\tContains the output from the \n ModifyClusterParameterGroup and ResetClusterParameterGroup actions and\n indicate the parameter group involved and the status of the operation on the \n parameter group.\n

" + }, + "ClusterParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The parameter group name does not refer to an\n existing parameter group.\n

" + }, + "ClusterParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in the user exceeding the allowed\n number of cluster parameter groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "ClusterParameterGroupStatus":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group.\n

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

\n The status of parameter updates.\n

" + } + }, + "documentation":"

\n Describes the status of a parameter group.\n

" + }, + "ClusterParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"ClusterParameterGroupStatus", + "locationName":"ClusterParameterGroup" + } + }, + "ClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "ParameterGroups":{ + "shape":"ParameterGroupList", + "documentation":"

\n A list of ClusterParameterGroup instances. Each instance describes one cluster parameter\n group.\n

" + } + }, + "documentation":"

\n\t\tContains the output from the DescribeClusterParameterGroups action.\n

" + }, + "ClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would exceed the allowed number of cluster instances for this account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "ClusterSecurityGroup":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster security group to which the operation was applied.\n

" + }, + "Description":{ + "shape":"String", + "documentation":"

\n A description of the security group.\n

" + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

\n A list of EC2 security groups that are permitted to access clusters associated with \n this cluster security group.\n

" + }, + "IPRanges":{ + "shape":"IPRangeList", + "documentation":"

\n A list of IP ranges (CIDR blocks) that are permitted to access \n clusters associated with this cluster security group.\n

" + } + }, + "wrapper":true, + "documentation":"

Describes a security group.

" + }, + "ClusterSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n A cluster security group with the same name already exists.\n

" + }, + "ClusterSecurityGroupMembership":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster security group.\n

" + }, + "Status":{ + "shape":"String", + "documentation":"

\n The status of the cluster security group.\n

" + } + }, + "documentation":"

Describes a security group.

" + }, + "ClusterSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"ClusterSecurityGroupMembership", + "locationName":"ClusterSecurityGroup" + } + }, + "ClusterSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroups", + "documentation":"

\n A list of ClusterSecurityGroup instances.\n

" + } + }, + "documentation":"

\n\t\tContains the output from the DescribeClusterSecurityGroups action.\n

" + }, + "ClusterSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ClusterSecurityGroupName" + } + }, + "ClusterSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster security group name does not refer to an existing cluster security group.\n

" + }, + "ClusterSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.ClusterSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in the user exceeding the allowed number of cluster security groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "ClusterSecurityGroups":{ + "type":"list", + "member":{ + "shape":"ClusterSecurityGroup", + "locationName":"ClusterSecurityGroup" + } + }, + "ClusterSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The value specified as a snapshot identifier is already used by an existing snapshot.\n

" + }, + "ClusterSnapshotCopyStatus":{ + "type":"structure", + "members":{ + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

" + }, + "RetentionPeriod":{ + "shape":"Long", + "documentation":"

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

" + } + }, + "documentation":"

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

" + }, + "ClusterSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

" + }, + "ClusterSnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in the user exceeding the allowed number of cluster snapshots.\n

" + }, + "ClusterSubnetGroup":{ + "type":"structure", + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster subnet group.\n

" + }, + "Description":{ + "shape":"String", + "documentation":"

\n The description of the cluster subnet group.\n

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

\n The VPC ID of the cluster subnet group.\n

" + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

\n The status of the cluster subnet group. Possible values are Complete, \n Incomplete and Invalid.\n

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

\n A list of the VPC Subnet elements.\n

" + } + }, + "wrapper":true, + "documentation":"

Describes a subnet group.

" + }, + "ClusterSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n A ClusterSubnetGroupName is already used by an existing cluster subnet group.\n

" + }, + "ClusterSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "ClusterSubnetGroups":{ + "shape":"ClusterSubnetGroups", + "documentation":"

\n A list of ClusterSubnetGroup instances.\n

" + } + }, + "documentation":"

\n Contains the output from the \n DescribeClusterSubnetGroups action.\n

" + }, + "ClusterSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

" + }, + "ClusterSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in user exceeding the allowed number of cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "ClusterSubnetGroups":{ + "type":"list", + "member":{ + "shape":"ClusterSubnetGroup", + "locationName":"ClusterSubnetGroup" + } + }, + "ClusterSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "ClusterVersion":{ + "type":"structure", + "members":{ + "ClusterVersion":{ + "shape":"String", + "documentation":"

\n The version number used by the cluster.\n

" + }, + "ClusterParameterGroupFamily":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group family for the cluster.\n

" + }, + "Description":{ + "shape":"String", + "documentation":"

\n The description of the cluster version.\n

" + } + }, + "documentation":"

Describes a cluster version, including the parameter group family and description of\n the version.

" + }, + "ClusterVersionList":{ + "type":"list", + "member":{ + "shape":"ClusterVersion", + "locationName":"ClusterVersion" + } + }, + "ClusterVersionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "ClusterVersions":{ + "shape":"ClusterVersionList", + "documentation":"

\n A list of Version elements.\n

" + } + }, + "documentation":"

\n Contains the output from the DescribeClusterVersions action.\n

" + }, + "ClustersMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "Clusters":{ + "shape":"ClusterList", + "documentation":"

\n A list of Cluster objects, where each object describes one cluster. \n

" + } + }, + "documentation":"

\n Contains the output from the DescribeClusters action.\n

" + }, + "CopyClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceSnapshotIdentifier", + "TargetSnapshotIdentifier" + ], + "members":{ + "SourceSnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier for the source snapshot.\n

\n

Constraints:

\n " + }, + "SourceSnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

\n

Constraints:

\n " + }, + "TargetSnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier given to the new manual snapshot.\n

\n

Constraints:

\n " + } + }, + "documentation":"

\n\n

" + }, + "CopyToRegionDisabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CopyToRegionDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Cross-region snapshot copy was temporarily disabled. Try your request again.\n

" + }, + "CreateClusterMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "NodeType", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

The name of the first database to be created when the cluster\n is created.

\n

To create additional databases after the cluster is created, connect to the\n cluster with a SQL client and use SQL commands to create a database.\n For more information, go to\n Create a Database in the Amazon Redshift Database Developer Guide. \n

\n

Default: dev

\n

Constraints:

\n " + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n A unique identifier for the cluster. You use this identifier to refer to the \n cluster for any subsequent cluster operations such as deleting or modifying. \n The identifier also appears in the Amazon Redshift console.\n

\n \n

Constraints:

\n\n\n

Example: myexamplecluster

" + }, + "ClusterType":{ + "shape":"String", + "documentation":"

\n The type of the cluster. When cluster type is specified as\n

\n

\n

\n Valid Values: multi-node | single-node\n

\n

Default: multi-node

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

\n The node type to be provisioned for the cluster. \n For information about node types, go to \n Working with Clusters in the Amazon Redshift Management Guide.

\n

\n Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge. \n

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

\n The user name associated with the master user account for the cluster that is being created.\n

\n

Constraints:

\n " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

\n The password associated with the master user account for the cluster that is being created.\n

\n

\n Constraints:\n

\n " + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroupNameList", + "documentation":"

\n A list of security groups to be associated\n with this cluster.\n

\n

\n Default: The default cluster security group for Amazon Redshift. \n

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

\n

Default: The default VPC security group is associated with the cluster.

" + }, + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

\n The name of a cluster subnet group to be associated with this cluster.\n

\n

\n If this parameter is not provided the resulting cluster will be deployed\n outside virtual private cloud (VPC).\n

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

\n The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. \n For example, if you have several \n EC2 instances running in a specific Availability Zone, then you might \n want the cluster to be provisioned in the same zone in order to decrease network latency. \n

\n

\n Default: A random, system-chosen Availability Zone in the region that is specified\n by the endpoint.\n

\n

\n Example: us-east-1d\n

\n

\n Constraint: The specified Availability Zone must be in the same region as the current endpoint.\n

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

\n The weekly time range (in UTC) during which automated cluster maintenance can occur.\n

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

\n Default: A 30-minute window selected at random from an\n 8-hour block of time per region, occurring on a random day of the\n week. The following list shows the time blocks for each region \n from which the default maintenance windows are assigned.\n

\n \n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Minimum 30-minute window.

" + }, + "ClusterParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the parameter group to be associated\n with this cluster. \n

\n

Default: The default Amazon Redshift \n cluster parameter group. For information about the default parameter group,\n go to Working with Amazon Redshift Parameter Groups

\n

\n Constraints:\n

\n " + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

\n The number of days that automated snapshots are retained.\n If the value is 0, automated snapshots are disabled. Even if\n automated snapshots are disabled, you can still create\n manual snapshots when you want with CreateClusterSnapshot.\n

\n

\n Default: 1\n

\n

Constraints: Must be a value from 0 to 35.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

\n The port number on which the cluster accepts incoming connections.\n

\n

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the\n connection string requires the port on which the cluster will listen for incoming connections.

\n

\n Default: 5439\n

\n

\n Valid Values: 1150-65535\n

" + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

\n The version of the Amazon Redshift engine software that you want to deploy on the cluster.\n

\n

\n The version selected \n runs on all the nodes in the cluster.\n

\n

Constraints: Only version 1.0 is currently available.

\n

Example: 1.0

" + }, + "AllowVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

If true, upgrades can be applied during the maintenance window to the \n Amazon Redshift engine that is running on the cluster.

\n

\n When a new version of the Amazon Redshift engine is released, \n you can request that the service automatically apply upgrades during the maintenance\n window to the Amazon Redshift engine \n that is running on your cluster. \n

\n

Default: true

" + }, + "NumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

\n The number of compute nodes in the cluster. \n This parameter is required when the ClusterType parameter is \n specified as multi-node.\n

\n

For information about determining how many nodes you need, go to \n Working with Clusters in the Amazon Redshift Management Guide.

\n \n

If you don't specify this parameter, you get a single-node cluster. When \n requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

\n

Default: 1

\n

Constraints: Value must be at least 1 and no more than 100.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

If true, the cluster can be accessed from a public network.

" + }, + "Encrypted":{ + "shape":"BooleanOptional", + "documentation":"

If true, the data in the cluster is encrypted at rest.

\n

Default: false

" + }, + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

" + }, + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

" + }, + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP (EIP) address for the cluster.

\n

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Management Guide.

" + } + }, + "documentation":"

" + }, + "CreateClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "ParameterGroupName", + "ParameterGroupFamily", + "Description" + ], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group. \n

\n

\n Constraints:\n

\n \n This value is stored as a lower-case string." + }, + "ParameterGroupFamily":{ + "shape":"String", + "documentation":"

\n The Amazon Redshift engine version to which the \n cluster parameter group applies. The cluster engine version determines the\n set of parameters.

\n

To get a list of valid parameter group family names, you can call \n DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of \n all the parameter groups that are owned by your AWS account, including the default \n parameter groups for each Amazon Redshift engine version. \n The parameter group family names associated with the default parameter groups \n provide you the valid values. For example, a valid family name is \"redshift-1.0\".\n

" + }, + "Description":{ + "shape":"String", + "documentation":"

\n A description of the parameter group.\n

" + } + }, + "documentation":"

\n\n

" + }, + "CreateClusterSecurityGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSecurityGroupName", + "Description" + ], + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name for the security group.\n Amazon Redshift stores the value as a lowercase string.\n

\n

Constraints:

\n \n

Example: examplesecuritygroup

" + }, + "Description":{ + "shape":"String", + "documentation":"

\n A description for the security group.\n

" + } + }, + "documentation":"

???

" + }, + "CreateClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "ClusterIdentifier" + ], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n A unique identifier for the snapshot that you are requesting. This identifier must be unique for \n all snapshots within \n the AWS account.\n

\n

Constraints:

\n \n

Example: my-snapshot-id

" + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The cluster identifier for which you want a snapshot. \n

" + } + }, + "documentation":"

\n\n

" + }, + "CreateClusterSubnetGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSubnetGroupName", + "Description", + "SubnetIds" + ], + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

\n The name for the subnet group.\n Amazon Redshift stores the value as a lowercase string.\n

\n

Constraints:

\n \n

Example: examplesubnetgroup

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

\n An array of VPC subnet IDs. \n A maximum of 20 subnets can be modified in a single request.\n

" + } + }, + "documentation":"

\n

" + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

\n The name of the event subscription to be created.\n

\n

Constraints:

\n " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

\n The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by\n Amazon SNS when you create a topic and subscribe to it.\n

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

\n The type of source that will be generating the events. For example, if you want to be notified of events generated by a\n cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all \n Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.\n

\n

Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

" + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

\n A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as\n was specified in the source type parameter. The event subscription will return only events generated by the\n specified objects. If not specified, then events are returned for all objects within the source type specified.\n

\n

Example: my-cluster-1, my-cluster-2

\n

Example: my-snapshot-20131010

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

\n

Values: Configuration, Management, Monitoring, Security

" + }, + "Severity":{ + "shape":"String", + "documentation":"

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

\n

Values: ERROR, INFO

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

\n A Boolean value; set to true to activate the subscription, set to false to create the\n subscription but not active it.\n

" + } + }, + "documentation":"

" + }, + "CreateHsmClientCertificateMessage":{ + "type":"structure", + "required":["HsmClientCertificateIdentifier"], + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

The identifier to be assigned to the new HSM client certificate that the cluster\n will use to connect to the HSM to use the database encryption keys.

" + } + }, + "documentation":"

" + }, + "CreateHsmConfigurationMessage":{ + "type":"structure", + "required":[ + "HsmConfigurationIdentifier", + "Description", + "HsmIpAddress", + "HsmPartitionName", + "HsmPartitionPassword", + "HsmServerPublicCertificate" + ], + "members":{ + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

The identifier to be assigned to the new Amazon Redshift HSM configuration.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A text description of the HSM configuration to be created.

" + }, + "HsmIpAddress":{ + "shape":"String", + "documentation":"

The IP address that the Amazon Redshift cluster must use to access the HSM.

" + }, + "HsmPartitionName":{ + "shape":"String", + "documentation":"

The name of the partition in the HSM where the Amazon Redshift clusters will store\n their database encryption keys.

" + }, + "HsmPartitionPassword":{ + "shape":"String", + "documentation":"

The password required to access the HSM partition.

" + }, + "HsmServerPublicCertificate":{ + "shape":"String", + "documentation":"

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

" + } + }, + "documentation":"

" + }, + "DefaultClusterParameters":{ + "type":"structure", + "members":{ + "ParameterGroupFamily":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group family to which the\n engine default parameters apply.\n

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

\n The list of cluster default parameters.\n

" + } + }, + "wrapper":true, + "documentation":"

Describes the default cluster parameters for a parameter group family.

" + }, + "DeleteClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster to be deleted.\n

\n

Constraints:

\n " + }, + "SkipFinalClusterSnapshot":{ + "shape":"Boolean", + "documentation":"

\n Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. \n If true, a final cluster snapshot is not created. \n If false, a final cluster snapshot \n is created before the cluster is deleted.\n

\n The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.\n

Default: false

" + }, + "FinalClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this\n parameter is provided, SkipFinalClusterSnapshot must be false.\n

\n

Constraints:

\n " + } + }, + "documentation":"

\n \n

" + }, + "DeleteClusterParameterGroupMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the parameter group to be deleted.\n

\n

Constraints:

\n " + } + }, + "documentation":"

\n\n

" + }, + "DeleteClusterSecurityGroupMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster security group to be deleted.\n

" + } + }, + "documentation":"

\n

" + }, + "DeleteClusterSnapshotMessage":{ + "type":"structure", + "required":["SnapshotIdentifier"], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of the manual snapshot to be deleted.\n

\n

Constraints: Must be the name of an existing snapshot that is in the available state.

" + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

\n

Constraints: Must be the name of valid cluster.

" + } + }, + "documentation":"

\n\n

" + }, + "DeleteClusterSubnetGroupMessage":{ + "type":"structure", + "required":["ClusterSubnetGroupName"], + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cluster subnet group name to be deleted.

" + } + } + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the Amazon Redshift event notification subscription to be deleted.

" + } + }, + "documentation":"

" + }, + "DeleteHsmClientCertificateMessage":{ + "type":"structure", + "required":["HsmClientCertificateIdentifier"], + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the HSM client certificate to be deleted.

" + } + }, + "documentation":"

" + }, + "DeleteHsmConfigurationMessage":{ + "type":"structure", + "required":["HsmConfigurationIdentifier"], + "members":{ + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the Amazon Redshift HSM configuration to be deleted.

" + } + }, + "documentation":"

" + }, + "DescribeClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of a specific parameter group for which to return details. By default,\n details about all parameter groups and the default parameter group are returned.\n

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

\n\n

" + }, + "DescribeClusterParametersMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of a cluster parameter group for which to return details.\n

" + }, + "Source":{ + "shape":"String", + "documentation":"

\n The parameter types to return. Specify user to show parameters that are different form the\n default. Similarly, specify engine-default to show parameters that are the same as the default\n parameter group.\n

\n

Default: All parameter types returned.

\n \n

Valid Values: user | engine-default

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + } + }, + "DescribeClusterSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name of a cluster security group for which you are requesting details. \n You can specify either the Marker parameter or a ClusterSecurityGroupName\n parameter, but not both.\n

\n

\n Example: securitygroup1\n

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

\n

\n Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.\n

" + } + }, + "documentation":"

???

" + }, + "DescribeClusterSnapshotsMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster for which information about snapshots is requested. \n

" + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The snapshot identifier of the snapshot about which to return information.\n

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

\n The type of snapshots for which you are requesting information. \n By default, snapshots of all types are returned.\n

\n

\n Valid Values: automated | manual\n

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

\n A value that requests only snapshots created at or after the specified time. The time\n value is \n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2012-07-16T18:00:00Z

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

\n A time value that requests only snapshots created at or before the specified time. The time\n value is \n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2012-07-16T18:00:00Z

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + }, + "OwnerAccount":{ + "shape":"String", + "documentation":"

\n The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.\n

" + } + }, + "documentation":"

\n\n

" + }, + "DescribeClusterSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cluster subnet group for which information is requested.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

\n

" + }, + "DescribeClusterVersionsMessage":{ + "type":"structure", + "members":{ + "ClusterVersion":{ + "shape":"String", + "documentation":"

\n The specific cluster version to return.\n

\n

Example: 1.0

" + }, + "ClusterParameterGroupFamily":{ + "shape":"String", + "documentation":"

\n The name of a specific cluster parameter group family to return details for.\n

\n

Constraints:

\n " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + } + }, + "DescribeClustersMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of a cluster whose properties you are requesting.\n This parameter is case sensitive.\n

\n

The default is that all clusters defined for an account are returned.\n

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeClusters request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

\n

\n Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.\n

" + } + }, + "documentation":"

\n \n

" + }, + "DescribeDefaultClusterParametersMessage":{ + "type":"structure", + "required":["ParameterGroupFamily"], + "members":{ + "ParameterGroupFamily":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group family.\n

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

\n\n

" + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

\n The source type, such as cluster or parameter group, to which the described\n event categories apply.\n

\n

\n Valid values: cluster, snapshot, parameter group, and security group.\n

" + } + }, + "documentation":"

\n \n

" + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the Amazon Redshift event notification subscription to be described.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the event source for which events\n will be returned. If this parameter is not specified,\n then all sources are included in the response.\n

\n

Constraints:

\n

If SourceIdentifier is supplied, SourceType must also be provided.

\n " + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

\n The event source to retrieve events for.\n If no value is specified, all events are returned.\n

\n

Constraints:

\n

If SourceType is supplied, SourceIdentifier must also be provided.

\n " + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

\n The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

\n The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

\n The number of minutes prior to the time of the request for which to retrieve events. \n For example, if the request is sent at 18:00 and you specify a duration of 60,\n then only events which have occurred after 17:00 will be returned.\n

\n

Default: 60

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeEvents request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

\n\n

" + }, + "DescribeHsmClientCertificatesMessage":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

The identifier of a specific HSM client certificate for which you want information. If no\n identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

" + }, + "DescribeHsmConfigurationsMessage":{ + "type":"structure", + "members":{ + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

The identifier of a specific Amazon Redshift HSM configuration to be described. If no\n identifier is specified, information is returned for all HSM configurations\n owned by your AWS customer account.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

" + }, + "DescribeLoggingStatusMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster to get the logging status from. \n

\n

Example: examplecluster

" + } + }, + "documentation":"

\n \n

" + }, + "DescribeOrderableClusterOptionsMessage":{ + "type":"structure", + "members":{ + "ClusterVersion":{ + "shape":"String", + "documentation":"

The version filter value. Specify this parameter to show only \n the available offerings matching the specified version.

\n

Default: All versions.

\n

Constraints: Must be one of the version returned from DescribeClusterVersions.

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

" + }, + "DescribeReservedNodeOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

The unique identifier for the offering.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

to be provided.

" + }, + "DescribeReservedNodesMessage":{ + "type":"structure", + "members":{ + "ReservedNodeId":{ + "shape":"String", + "documentation":"

Identifier for the node reservation.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

\n The maximum number of response records to return in each call. \n If the number of remaining response records exceeds the specified MaxRecords value, \n a value is returned in a marker field of the response. \n You can retrieve the next set of records by retrying the command with the returned marker value.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n An optional parameter that specifies the starting point to return a set of response records. \n When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, \n AWS returns a value in the Marker field of the response. You can retrieve the next set of \n response records by providing the returned marker value in the Marker parameter and \n retrying the request.\n

" + } + }, + "documentation":"

\n

" + }, + "DescribeResizeMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of a cluster whose resize progress you are requesting.\n This parameter isn't case-sensitive.\n

\n

By default, resize operations for all clusters defined for an AWS account are returned.\n

" + } + }, + "documentation":"

\n\n

" + }, + "DisableLoggingMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster on which logging is to be stopped. \n

\n

Example: examplecluster

" + } + }, + "documentation":"

\n \n

" + }, + "DisableSnapshotCopyMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.\n

\n

\n Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.\n

" + } + }, + "documentation":"

\n \n

" + }, + "Double":{"type":"double"}, + "DoubleOptional":{"type":"double"}, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

\n The status of the EC2 security group.\n

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name of the EC2 Security Group.\n

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

\n The AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

" + } + }, + "documentation":"

Describes an Amazon EC2 security group.

" + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "ElasticIpStatus":{ + "type":"structure", + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The elastic IP (EIP) address for the cluster.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Describes the status of the elastic IP (EIP) address.

" + } + }, + "documentation":"

Describes the status of the elastic IP (EIP) address.

" + }, + "EnableLoggingMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "BucketName" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster on which logging is to be started. \n

\n

Example: examplecluster

" + }, + "BucketName":{ + "shape":"String", + "documentation":"

\n The name of an existing S3 bucket where the log files are to be stored. \n

\n

Constraints:

\n " + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

\n The prefix applied to the log file names. \n

\n

Constraints:

\n " + } + }, + "documentation":"

\n \n

" + }, + "EnableSnapshotCopyMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "DestinationRegion" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of the source cluster to copy snapshots from.\n

\n

\n Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.\n

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

\n The destination region that you want to copy snapshots to.\n

\n

\n Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference. \n

" + }, + "RetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

\n The number of days to retain automated snapshots in the destination region after they are copied from the source region.\n

\n

\n Default: 7.\n

\n

\n Constraints: Must be at least 1 and no more than 35.\n

" + } + }, + "documentation":"

\n \n

" + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

\n The DNS address of the Cluster.\n

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

\n The port that the database engine is listening on.\n

" + } + }, + "documentation":"

Describes a connection endpoint.

" + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier for the source of the event.\n

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

\n The source type for this event.\n

" + }, + "Message":{ + "shape":"String", + "documentation":"

\n The text of this event.\n

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

\n A list of the event categories.\n

" + }, + "Severity":{ + "shape":"String", + "documentation":"

The severity of the event.

\n

Values: ERROR, INFO

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

\n The date and time of the event.\n

" + }, + "EventId":{ + "shape":"String", + "documentation":"

\n The identifier of the event.\n

" + } + }, + "documentation":"

\n Describes an event.\n

" + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The Amazon Redshift source type, such as cluster or cluster-snapshot, that the returned categories belong to.

" + }, + "Events":{ + "shape":"EventInfoMapList", + "documentation":"

The events in the event category.

" + } + }, + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

\n A list of event categories descriptions.\n

" + } + }, + "documentation":"

\n \n

" + }, + "EventInfoMap":{ + "type":"structure", + "members":{ + "EventId":{ + "shape":"String", + "documentation":"

The identifier of an Amazon Redshift event.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

The category of an Amazon Redshift event.

" + }, + "EventDescription":{ + "shape":"String", + "documentation":"

The description of an Amazon Redshift event.

" + }, + "Severity":{ + "shape":"String", + "documentation":"

The severity of the event.

\n

Values: ERROR, INFO

" + } + }, + "wrapper":true + }, + "EventInfoMapList":{ + "type":"list", + "member":{ + "shape":"EventInfoMap", + "locationName":"EventInfoMap" + } + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{ + "shape":"String", + "documentation":"

The AWS customer account associated with the Amazon Redshift event notification subscription.

" + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

The name of the Amazon Redshift event notification subscription.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Amazon Redshift event notification subscription.

\n

Constraints:

\n " + }, + "SubscriptionCreationTime":{ + "shape":"TStamp", + "documentation":"

The date and time the Amazon Redshift event notification subscription was created.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The source type of the events returned the Amazon Redshift event notification, such as cluster, or\n cluster-snapshot.

" + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

A list of the sources that publish events to the Amazon Redshift event notification subscription.

" + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

The list of Amazon Redshift event categories specified in the event notification subscription.

\n

Values: Configuration, Management, Monitoring, Security

" + }, + "Severity":{ + "shape":"String", + "documentation":"

The event severity specified in the Amazon Redshift event notification subscription.

\n

Values: ERROR, INFO

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.

" + } + }, + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The request would exceed the allowed number of event subscriptions for this account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

A list of event subscriptions.

" + } + }, + "documentation":"

" + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

\n A list of Event instances.\n

" + } + }, + "documentation":"

\n\t\tContains the output from the DescribeEvents action.\n

" + }, + "HsmClientCertificate":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the HSM client certificate.

" + }, + "HsmClientCertificatePublicKey":{ + "shape":"String", + "documentation":"

The public key that the Amazon Redshift cluster will use to connect to the HSM. \n You must register the public key in the HSM.

" + } + }, + "wrapper":true, + "documentation":"

Returns information about an HSM client certificate. The certificate is stored in a secure\n Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to\n encrypt data files.

" + }, + "HsmClientCertificateAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmClientCertificateAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is already an existing Amazon Redshift HSM client certificate with the specified identifier.

" + }, + "HsmClientCertificateList":{ + "type":"list", + "member":{ + "shape":"HsmClientCertificate", + "locationName":"HsmClientCertificate" + } + }, + "HsmClientCertificateMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "HsmClientCertificates":{ + "shape":"HsmClientCertificateList", + "documentation":"

A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters\n to store and retrieve database encryption keys in an HSM.

" + } + }, + "documentation":"

" + }, + "HsmClientCertificateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmClientCertificateNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM client certificate with the specified identifier.

" + }, + "HsmClientCertificateQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmClientCertificateQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The quota for HSM client certificates has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "HsmConfiguration":{ + "type":"structure", + "members":{ + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

The name of the Amazon Redshift HSM configuration.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A text description of the HSM configuration.

" + }, + "HsmIpAddress":{ + "shape":"String", + "documentation":"

The IP address that the Amazon Redshift cluster must use to access the HSM.

" + }, + "HsmPartitionName":{ + "shape":"String", + "documentation":"

The name of the partition in the HSM where the Amazon Redshift clusters will store\n their database encryption keys.

" + } + }, + "wrapper":true, + "documentation":"

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift\n clusters the information they require to connect to an HSM where they can store database\n encryption keys.

" + }, + "HsmConfigurationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmConfigurationAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is already an existing Amazon Redshift HSM configuration with the specified identifier.

" + }, + "HsmConfigurationList":{ + "type":"list", + "member":{ + "shape":"HsmConfiguration", + "locationName":"HsmConfiguration" + } + }, + "HsmConfigurationMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "HsmConfigurations":{ + "shape":"HsmConfigurationList", + "documentation":"

A list of Amazon Redshift HSM configurations.

" + } + }, + "documentation":"

" + }, + "HsmConfigurationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmConfigurationNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is no Amazon Redshift HSM configuration with the specified identifier.

" + }, + "HsmConfigurationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmConfigurationQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The quota for HSM configurations has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "HsmStatus":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

" + }, + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

" + } + }, + "documentation":"

" + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

\n The status of the IP range, for example, \"authorized\".\n

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

\n The IP range in Classless Inter-Domain Routing (CIDR) notation.\n

" + } + }, + "documentation":"

\n Describes an IP range used in a security group. \n

" + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "ImportTablesCompleted":{ + "type":"list", + "member":{"shape":"String"} + }, + "ImportTablesInProgress":{ + "type":"list", + "member":{"shape":"String"} + }, + "ImportTablesNotStarted":{ + "type":"list", + "member":{"shape":"String"} + }, + "IncompatibleOrderableOptions":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"IncompatibleOrderableOptions", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified options are incompatible.\n

" + }, + "InsufficientClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The number of nodes specified exceeds the allotted capacity of the cluster.\n

" + }, + "InsufficientS3BucketPolicyFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientS3BucketPolicyFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster does not have read bucket or put object permissions\n on the S3 bucket specified when enabling logging.\n

" + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidClusterParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster parameter group action can not be completed because \n another task is in progress that involves the parameter group. \n Wait a few moments and try the operation again.\n

" + }, + "InvalidClusterSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster security group is not available.\n

" + }, + "InvalidClusterSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.\n

" + }, + "InvalidClusterStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified cluster is not in the available state.\n

" + }, + "InvalidClusterSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group cannot be deleted because it is in use.\n

" + }, + "InvalidClusterSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The state of the subnet is invalid.

" + }, + "InvalidElasticIpFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidElasticIpFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The Elastic IP (EIP) is invalid or cannot be found.

" + }, + "InvalidHsmClientCertificateStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidHsmClientCertificateStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified HSM client certificate is not in the available state, or it is still in\n use by one or more Amazon Redshift clusters.

" + }, + "InvalidHsmConfigurationStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidHsmConfigurationStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified HSM configuration is not in the available state, or it is still in\n use by one or more Amazon Redshift clusters.

" + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestore", + "httpStatusCode":406, + "senderFault":true + }, + "exception":true, + "documentation":"

The restore is invalid.

" + }, + "InvalidS3BucketNameFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidS3BucketNameFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.

" + }, + "InvalidS3KeyPrefixFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidS3KeyPrefixFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The string specified for the logging S3 key prefix does not comply with\n the documented constraints.\n

" + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

" + }, + "InvalidSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubscriptionStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.\n

" + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster subnet group does not cover all Availability Zones.\n

" + }, + "LoggingStatus":{ + "type":"structure", + "members":{ + "LoggingEnabled":{ + "shape":"Boolean", + "documentation":"

true if logging is on, false if logging is off.

" + }, + "BucketName":{ + "shape":"String", + "documentation":"

The name of the S3 bucket where the log files are stored.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

The prefix applied to the log file names.

" + }, + "LastSuccessfulDeliveryTime":{ + "shape":"TStamp", + "documentation":"

\n The last time when logs were delivered.\n

" + }, + "LastFailureTime":{ + "shape":"TStamp", + "documentation":"

\n The last time when logs failed to be delivered.\n

" + }, + "LastFailureMessage":{ + "shape":"String", + "documentation":"

\n The message indicating that logs failed to be delivered.\n

" + } + }, + "documentation":"

Describes the status of logging for a cluster.

" + }, + "Long":{"type":"long"}, + "LongOptional":{"type":"long"}, + "ModifyClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of the cluster to be modified. \n

\n

Example: examplecluster

" + }, + "ClusterType":{ + "shape":"String", + "documentation":"

\n The new cluster type.\n

\n

\n When you submit your cluster resize request, your existing cluster goes into a \n read-only mode. After Amazon Redshift provisions a new cluster based on your \n resize requirements, there will be outage for a period while the old cluster is \n deleted and your connection is switched to the new cluster.\n You can use DescribeResize to track the progress of the resize request. \n

\n

Valid Values: multi-node | single-node

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

\n The new node type of the cluster. If you specify a new node type, \n you must also specify the number of nodes parameter also.\n

\n

\n When you submit your request to resize a cluster, \n Amazon Redshift sets access permissions for the cluster to read-only.\n After Amazon Redshift provisions a new cluster according to your \n resize requirements, there will be a temporary outage while the old cluster is \n deleted and your connection is switched to the new cluster. When\n the new connection is complete, the original access permissions for the\n cluster are restored.\n You can use the DescribeResize to track the progress of the resize request.\n

\n

Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.

" + }, + "NumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

\n The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter also.\n

\n

\n When you submit your request to resize a cluster, \n Amazon Redshift sets access permissions for the cluster to read-only.\n After Amazon Redshift provisions a new cluster according to your \n resize requirements, there will be a temporary outage while the old cluster is \n deleted and your connection is switched to the new cluster. When\n the new connection is complete, the original access permissions for the\n cluster are restored.\n You can use DescribeResize to track the progress of the resize request.\n

\n

Valid Values: Integer greater than 0.

" + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroupNameList", + "documentation":"

\n A list of cluster security groups to be authorized on this cluster.\n This change is asynchronously applied as soon as possible. \n

\n

Security groups currently associated with the cluster, and not in \n the list of groups to apply, will be revoked from the cluster.

\n

Constraints:

\n " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

\n A list of virtual private cloud (VPC) security groups to be associated with the cluster.\n

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

\n The new password for the cluster master user.\n This change is asynchronously applied as soon as possible.\n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n \n Operations never return the password, so this operation provides a way to \n regain access to the master user account for a cluster if the password is lost.\n \n

\n

Default: Uses existing setting.

\n

\n Constraints:\n

\n " + }, + "ClusterParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group to apply to this cluster.\n This change is applied only after the cluster is rebooted. To reboot\n a cluster use RebootCluster.\n

\n

Default: Uses existing setting.

\n

Constraints: The cluster parameter group must be in the same \n parameter group family that matches the cluster version.

" + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

\n The number of days that automated snapshots are retained.\n If the value is 0, automated snapshots are disabled. Even if\n automated snapshots are disabled, you can still create\n manual snapshots when you want with CreateClusterSnapshot.\n

\n

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

\n

Default: Uses existing setting.

\n

Constraints: Must be a value from 0 to 35.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

\n The weekly time range (in UTC) during which system maintenance can occur, if necessary.\n If system maintenance is necessary during the window, it may result in an outage. \n

\n

\n This maintenance window change is made immediately.\n If the new maintenance window indicates the current time,\n there must be at least 120 minutes between the current time and\n end of the window in order to ensure that pending changes are applied. \n

\n

Default: Uses existing setting.

\n

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes.

" + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

\n The new version number of the Amazon Redshift engine to upgrade to.\n

\n

\n For major version upgrades, if a non-default cluster parameter group is currently in use,\n a new cluster parameter group in the cluster parameter group family\n for the new version must be specified.\n The new cluster parameter group can be the default for that cluster parameter group family.\n \nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n\n

\n

Example: 1.0

" + }, + "AllowVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

\n If true, upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n

Default: false

" + }, + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

" + }, + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

" + }, + "NewClusterIdentifier":{ + "shape":"String", + "documentation":"

The new identifier for the cluster.

\n \n

Constraints:

\n\n\n

Example: examplecluster

" + } + }, + "documentation":"

" + }, + "ModifyClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "ParameterGroupName", + "Parameters" + ], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the parameter group to be modified.\n

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

\n An array of parameters to be modified. \n A maximum of 20 parameters can be modified in a single request.\n

\n

\n For each parameter to be modified, you must supply at least the parameter name\n and parameter value; other name-value pairs of the parameter are optional.\n

\n

\n For the workload management (WLM) configuration, \n you must supply all the name-value pairs in the wlm_json_configuration parameter.\n

" + } + }, + "documentation":"

\n\n

" + }, + "ModifyClusterSubnetGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSubnetGroupName", + "SubnetIds" + ], + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the subnet group to be modified.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A text description of the subnet group to be modified.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

\n An array of VPC subnet IDs. \n A maximum of 20 subnets can be modified in a single request.\n

" + } + }, + "documentation":"

\n\n

" + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

\n The name of the modified Amazon Redshift event notification subscription.\n

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

\n The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.\n

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

\n The type of source that will be generating the events. For example, if you want to be notified of events generated by a\n cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all \n Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.\n

\n

Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

" + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

\n A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as\n was specified in the source type parameter. The event subscription will return only events generated by the\n specified objects. If not specified, then events are returned for all objects within the source type specified.\n

\n

Example: my-cluster-1, my-cluster-2

\n

Example: my-snapshot-20131010

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

\n

Values: Configuration, Management, Monitoring, Security

" + }, + "Severity":{ + "shape":"String", + "documentation":"

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

\n

Values: ERROR, INFO

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

\n A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled\n

" + } + }, + "documentation":"

" + }, + "ModifySnapshotCopyRetentionPeriodMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "RetentionPeriod" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.\n

\n

\n Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.\n

" + }, + "RetentionPeriod":{ + "shape":"Integer", + "documentation":"

\n The number of days to retain automated snapshots in the destination region after they are copied from the source region.\n

\n

\n If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.\n

\n

\n Constraints: Must be at least 1 and no more than 35.\n

" + } + }, + "documentation":"

\n \n

" + }, + "NumberOfNodesPerClusterLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"NumberOfNodesPerClusterLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The operation would exceed the number of nodes allowed for a cluster.

" + }, + "NumberOfNodesQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"NumberOfNodesQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The operation would exceed the number of nodes allotted to the account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n

" + }, + "OrderableClusterOption":{ + "type":"structure", + "members":{ + "ClusterVersion":{ + "shape":"String", + "documentation":"

\n The version of the orderable cluster.\n

" + }, + "ClusterType":{ + "shape":"String", + "documentation":"

\n The cluster type, for example multi-node.\n

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

\n The node type for the orderable cluster. \n

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

\n A list of availability zones for the orderable cluster. \n

" + } + }, + "wrapper":true, + "documentation":"

\n Describes an orderable cluster option. \n

" + }, + "OrderableClusterOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableClusterOption", + "locationName":"OrderableClusterOption" + } + }, + "OrderableClusterOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableClusterOptions":{ + "shape":"OrderableClusterOptionsList", + "documentation":"

An OrderableClusterOption structure containing information about orderable options for the Cluster.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + } + }, + "documentation":"

\n Contains the output from the DescribeOrderableClusterOptions action. \n

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

\n The name of the parameter.\n

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

\n The value of the parameter.\n

" + }, + "Description":{ + "shape":"String", + "documentation":"

\n A description of the parameter.\n

" + }, + "Source":{ + "shape":"String", + "documentation":"

\n The source of the parameter value, such as \"engine-default\" or \"user\".\n

" + }, + "DataType":{ + "shape":"String", + "documentation":"

\n The data type of the parameter.\n

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

\n The valid range of values for the parameter.\n

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

\n If true, the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

\n The earliest engine version to which the parameter can apply.\n

" + } + }, + "documentation":"

\n Describes a parameter in a cluster parameter group.\n

" + }, + "ParameterGroupList":{ + "type":"list", + "member":{ + "shape":"ClusterParameterGroup", + "locationName":"ClusterParameterGroup" + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "MasterUserPassword":{ + "shape":"String", + "documentation":"

\n The pending or in-progress change of the master user password for the cluster.\n

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

\n The pending or in-progress change of the cluster's node type.\n

" + }, + "NumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

\n The pending or in-progress change of the number of nodes in the cluster. \n

" + }, + "ClusterType":{ + "shape":"String", + "documentation":"

\n The pending or in-progress change of the cluster type.\n

" + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

\n The pending or in-progress change of the service version. \n

" + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

\n The pending or in-progress change of the automated snapshot retention period. \n

" + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

The pending or in-progress change of the new identifier for the cluster.

" + } + }, + "documentation":"

\n Describes cluster attributes that are in a pending state. A change to one or\n more the attributes was requested and is in progress or will be applied.\n

" + }, + "PurchaseReservedNodeOfferingMessage":{ + "type":"structure", + "required":["ReservedNodeOfferingId"], + "members":{ + "ReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

The unique identifier of the reserved node offering you want to purchase.

" + }, + "NodeCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of reserved nodes you want to purchase.

\n

Default: 1

" + } + }, + "documentation":"

" + }, + "RebootClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The cluster identifier.\n

" + } + }, + "documentation":"

\n\n

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

The amount charged per the period of time specified by the recurring charge frequency.

" + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

The frequency at which the recurring charge amount is applied.

" + } + }, + "wrapper":true, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "ReservedNode":{ + "type":"structure", + "members":{ + "ReservedNodeId":{ + "shape":"String", + "documentation":"

\n The unique identifier for the reservation.\n

" + }, + "ReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

\n The identifier for the reserved node offering.\n

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

\n The node type of the reserved node.\n

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

\n The time the reservation started. You purchase a reserved node offering for a duration. This is the start\n time of that duration.\n

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

\n The duration of the node reservation in seconds.\n

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

\n The fixed cost Amazon Redshift charged you for this reserved node.\n

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

\n The hourly rate Amazon Redshift charge you for this reserved node.\n

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved cluster.

" + }, + "NodeCount":{ + "shape":"Integer", + "documentation":"

\n The number of reserved compute nodes.\n

" + }, + "State":{ + "shape":"String", + "documentation":"

\n The state of the reserved Compute Node. \n

\n

Possible Values:

\n " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The anticipated utilization of the reserved node, as defined in the reserved node offering.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring charges for the reserved node.

" + } + }, + "wrapper":true, + "documentation":"

\n Describes a reserved node.\n

" + }, + "ReservedNodeAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n User already has a reservation with the given identifier.\n

" + }, + "ReservedNodeList":{ + "type":"list", + "member":{ + "shape":"ReservedNode", + "locationName":"ReservedNode" + } + }, + "ReservedNodeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified reserved compute node not found.\n

" + }, + "ReservedNodeOffering":{ + "type":"structure", + "members":{ + "ReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

\n The offering identifier.\n

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

\n The node type offered by the reserved node offering.\n

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

\n The duration, in seconds, for which the offering will reserve the node.\n

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

\n The upfront fixed charge you will pay to purchase the specific reserved node offering.\n

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

\n The rate you are charged for each hour the cluster that is using the offering is running.\n

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

\n The currency code for the compute nodes offering.\n

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The anticipated utilization of the reserved node, as defined in the reserved node offering.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The charge to your account regardless of whether you are creating any clusters using the node offering.\n Recurring charges are only in effect for heavy-utilization reserved nodes.\n

" + } + }, + "wrapper":true, + "documentation":"

Describes a reserved node offering.

" + }, + "ReservedNodeOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedNodeOffering", + "locationName":"ReservedNodeOffering" + } + }, + "ReservedNodeOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedNodeOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Specified offering does not exist.\n

" + }, + "ReservedNodeOfferingsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "ReservedNodeOfferings":{ + "shape":"ReservedNodeOfferingList", + "documentation":"

A list of reserved node offerings.

" + } + }, + "documentation":"

\n Contains the output from the DescribeReservedNodeOfferings action. \n

" + }, + "ReservedNodeQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Request would exceed the user's compute node quota. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

" + }, + "ReservedNodesMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "ReservedNodes":{ + "shape":"ReservedNodeList", + "documentation":"

The list of reserved nodes.

" + } + }, + "documentation":"

Contains the output from the DescribeReservedNodes action.

" + }, + "ResetClusterParameterGroupMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the cluster parameter group to be reset.\n

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

\n If true, all parameters\n in the specified parameter group will be reset to their default values.\n

\n

Default: true

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

\n An array of names of parameters to be reset. If ResetAllParameters option is not used, \n then at least one parameter name must be supplied. \n

\n

Constraints: A maximum of 20 parameters can be reset in a single request.

" + } + }, + "documentation":"

\n\n

" + }, + "ResizeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResizeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

A resize operation for the specified cluster is not found.

" + }, + "ResizeProgressMessage":{ + "type":"structure", + "members":{ + "TargetNodeType":{ + "shape":"String", + "documentation":"

The node type that the cluster will have after the resize operation is complete.

" + }, + "TargetNumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of nodes that the cluster will have after the resize operation is complete.

" + }, + "TargetClusterType":{ + "shape":"String", + "documentation":"

The cluster type after the resize operation is complete.

\n

Valid Values: multi-node | single-node

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the resize operation.

\n

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED

" + }, + "ImportTablesCompleted":{ + "shape":"ImportTablesCompleted", + "documentation":"

The names of tables that have been completely imported .

\n

Valid Values: List of table names.

" + }, + "ImportTablesInProgress":{ + "shape":"ImportTablesInProgress", + "documentation":"

The names of tables that are being currently imported.

\n

Valid Values: List of table names.

" + }, + "ImportTablesNotStarted":{ + "shape":"ImportTablesNotStarted", + "documentation":"

The names of tables that have not been yet imported.

\n

Valid Values: List of table names

" + }, + "AvgResizeRateInMegaBytesPerSecond":{ + "shape":"DoubleOptional", + "documentation":"

The average rate of the resize operation over the last few minutes, measured in megabytes per second. \n After the resize operation completes, this value shows the average rate of the entire resize operation.

" + }, + "TotalResizeDataInMegaBytes":{ + "shape":"LongOptional", + "documentation":"

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

" + }, + "ProgressInMegaBytes":{ + "shape":"LongOptional", + "documentation":"

While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. \n When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, \n which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

" + }, + "ElapsedTimeInSeconds":{ + "shape":"LongOptional", + "documentation":"

The amount of seconds that have elapsed since the resize operation began. \n After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

" + }, + "EstimatedTimeToCompletionInSeconds":{ + "shape":"LongOptional", + "documentation":"

The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate \n and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

" + } + }, + "documentation":"

Describes the result of a cluster resize operation.

" + }, + "RestoreFromClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "SnapshotIdentifier" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster that will be created from restoring the snapshot.\n

\n

\n \n

Constraints:

\n\n\n

" + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The name of the snapshot from which to create the new cluster.\n This parameter isn't case sensitive. \n

\n

Example: my-snapshot-id

" + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

\n The port number on which the cluster accepts connections.\n

\n

Default: The same port as the original cluster.

\n

Constraints: Must be between 1115 and 65535.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

\n The Amazon EC2 Availability Zone in which to restore the cluster.\n

\n

Default: A random, system-chosen Availability Zone.

\n

Example: us-east-1a

" + }, + "AllowVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

\n If true, upgrades can be applied during the maintenance window to the \n Amazon Redshift engine that is running on the cluster.\n

\n

Default: true

" + }, + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

\n The name of the subnet group where you want to cluster restored. \n

\n

\n A snapshot of cluster in VPC can be restored only in VPC. Therefore, \n you must provide subnet group name where you want the cluster restored.\n

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

\n If true, the cluster can be accessed from a public network.\n

" + }, + "OwnerAccount":{ + "shape":"String", + "documentation":"

\n The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. \n

" + }, + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

" + }, + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

" + }, + "ElasticIp":{ + "shape":"String", + "documentation":"

The elastic IP (EIP) address for the cluster.

" + }, + "ClusterParameterGroupName":{ + "shape":"String", + "documentation":"

\n The name of the parameter group to be associated\n with this cluster. \n

\n

Default: The default Amazon Redshift \n cluster parameter group. For information about the default parameter group,\n go to Working with Amazon Redshift Parameter Groups.

\n

\n Constraints:\n

\n " + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroupNameList", + "documentation":"

\n A list of security groups to be associated\n with this cluster.\n

\n

\n Default: The default cluster security group for Amazon Redshift. \n

\n

Cluster security groups only apply to clusters outside of VPCs.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

\n A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.\n

\n

\n Default: The default VPC security group is associated with the cluster.\n

\n

\n VPC security groups only apply to clusters in VPCs.\n

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

\n The weekly time range (in UTC) during which automated cluster maintenance can occur.\n

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

\n Default: The value selected for the cluster from which the snapshot was taken. \n The following list shows the time blocks for each region \n from which the default maintenance windows are assigned.\n

\n \n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Minimum 30-minute window.

" + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

\n The number of days that automated snapshots are retained.\n If the value is 0, automated snapshots are disabled. Even if\n automated snapshots are disabled, you can still create\n manual snapshots when you want with CreateClusterSnapshot.\n

\n

\n Default: The value selected for the cluster from which the snapshot was taken.\n

\n

Constraints: Must be a value from 0 to 35.

" + } + }, + "documentation":"

" + }, + "RestoreStatus":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

" + }, + "CurrentRestoreRateInMegaBytesPerSecond":{ + "shape":"Double", + "documentation":"

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

" + }, + "SnapshotSizeInMegaBytes":{ + "shape":"Long", + "documentation":"

\n The size of the set of snapshot data used to restore the cluster.\n

" + }, + "ProgressInMegaBytes":{ + "shape":"Long", + "documentation":"

\n The number of megabytes that have been transferred from snapshot storage.\n

" + }, + "ElapsedTimeInSeconds":{ + "shape":"Long", + "documentation":"

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

" + }, + "EstimatedTimeToCompletionInSeconds":{ + "shape":"Long", + "documentation":"

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

" + } + }, + "documentation":"

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

" + }, + "RevokeClusterSecurityGroupIngressMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name of the security Group from which to revoke the ingress rule.\n

" + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

\n The IP range for which to revoke access. \n This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. \n If CIDRIP is specified,\n EC2SecurityGroupName and EC2SecurityGroupOwnerId\n cannot be provided.\n

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

\n The name of the EC2 Security Group whose access is to be revoked.\n If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId \n must also be provided and CIDRIP cannot be provided.\n

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

\n The AWS account number of the owner of the security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID is not an acceptable value.\n If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName \n must also be provided. and CIDRIP cannot be provided.\n

\n

Example: 111122223333

" + } + }, + "documentation":"

\n ???\n

" + }, + "RevokeSnapshotAccessMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the snapshot that the account can no longer access. \n

" + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

" + }, + "AccountWithRestoreAccess":{ + "shape":"String", + "documentation":"

\n The identifier of the AWS customer account that can no longer restore the specified snapshot. \n

" + } + }, + "documentation":"

\n \n

" + }, + "RotateEncryptionKeyMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The unique identifier of the cluster that you want to rotate the encryption keys for.\n

\n

\n Constraints: Must be the name of valid cluster that has encryption enabled.\n

" + } + }, + "documentation":"

\n \n

" + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

" + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You do not have permission to publish to the specified Amazon SNS topic.

" + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

\n The snapshot identifier that is provided in the request.\n

" + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the cluster for which the snapshot was taken.\n

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

\n The time (UTC) when Amazon Redshift began the snapshot. \n A snapshot contains a copy of the cluster data as of this exact time. \n

" + }, + "Status":{ + "shape":"String", + "documentation":"

\n The snapshot status. The value of the status depends on the API operation used.\n

\n

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

\n The port that the cluster is listening on.\n

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

\n The Availability Zone in which the cluster was created.\n

" + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

\n The time (UTC) when the cluster was originally created.\n

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

\n The master user name for the cluster.\n

" + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

\n The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".\n

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

The node type of the nodes in the cluster.

" + }, + "NumberOfNodes":{ + "shape":"Integer", + "documentation":"

The number of nodes in the cluster.

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The name of the database that was created when the cluster was created.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,\n this field is not in the output.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

If true, the data in the snapshot is encrypted at rest.

" + }, + "EncryptedWithHSM":{ + "shape":"Boolean", + "documentation":"

A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM keys.

" + }, + "AccountsWithRestoreAccess":{ + "shape":"AccountsWithRestoreAccessList", + "documentation":"

\n A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.\n

" + }, + "OwnerAccount":{ + "shape":"String", + "documentation":"

\n For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.\n

" + }, + "TotalBackupSizeInMegaBytes":{ + "shape":"Double", + "documentation":"

\n The size of the complete set of backup data that would be used to restore the cluster.\n

" + }, + "ActualIncrementalBackupSizeInMegaBytes":{ + "shape":"Double", + "documentation":"

\n The size of the incremental backup.\n

" + }, + "BackupProgressInMegaBytes":{ + "shape":"Double", + "documentation":"

\n The number of megabytes that have been transferred to the snapshot backup.\n

" + }, + "CurrentBackupRateInMegaBytesPerSecond":{ + "shape":"Double", + "documentation":"

\n The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.\n

" + }, + "EstimatedSecondsToCompletion":{ + "shape":"Long", + "documentation":"

\n The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup. \n

" + }, + "ElapsedTimeInSeconds":{ + "shape":"Long", + "documentation":"

\n The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.\n

" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

\n The source region from which the snapshot was copied.\n

" + } + }, + "wrapper":true, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotCopyAlreadyDisabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyAlreadyDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster already has cross-region snapshot copy disabled.\n

" + }, + "SnapshotCopyAlreadyEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyAlreadyEnabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The cluster already has cross-region snapshot copy enabled.\n

" + }, + "SnapshotCopyDisabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Cross-region snapshot copy was temporarily disabled. Try your request again.\n

" + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"Snapshot" + } + }, + "SnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

\n A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned \n marker value in the Marker parameter and retrying the command. If the Marker field\n is empty, all response records have been retrieved for the request.\n

" + }, + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

\n A list of Snapshot instances.\n

" + } + }, + "documentation":"

\n\t\tContains the output from the DescribeClusterSnapshots action.\n

" + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon Redshift event source could not be found.

" + }, + "SourceType":{ + "type":"string", + "enum":[ + "cluster", + "cluster-parameter-group", + "cluster-security-group", + "cluster-snapshot" + ] + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

\n The identifier of the subnet.\n

" + }, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{ + "shape":"String", + "documentation":"

\n The status of the subnet.\n

" + } + }, + "documentation":"

\n Describes a subnet.\n

" + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n A specified subnet is already in use by another cluster.\n

" + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

There is already an existing event notification subscription with the specified name.

" + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The value specified for the event category was not one of the allowed values, or\n it specified a category that does not apply to the specified source type. The allowed\n values are Configuration, Management, Monitoring, and Security.

" + }, + "SubscriptionEventIdNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionEventIdNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon Redshift event with the specified event ID does not exist.

" + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

An Amazon Redshift event notification subscription with the specified name does not exist.

" + }, + "SubscriptionSeverityNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionSeverityNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The value specified for the event severity was not one of the allowed values, or\n it specified a severity that does not apply to the specified source type. The allowed\n values are ERROR and INFO.

" + }, + "TStamp":{"type":"timestamp"}, + "UnauthorizedOperation":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

\n Your account is not authorized to perform the requested operation.\n

" + }, + "UnknownSnapshotCopyRegionFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"UnknownSnapshotCopyRegionFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

\n The specified region is incorrect or does not exist.\n

" + }, + "UnsupportedOptionFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"UnsupportedOptionFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A request option was specified that is not supported. \n

" + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{"shape":"String"}, + "Status":{"shape":"String"} + }, + "documentation":"

Describes the members of a VPC security group.

" + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroup" + } + }, + "AuthorizeClusterSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "AuthorizeSnapshotAccessResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CopyClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CreateClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "CreateClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "ClusterParameterGroup":{"shape":"ClusterParameterGroup"} + } + }, + "CreateClusterSecurityGroupResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "CreateClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CreateClusterSubnetGroupResult":{ + "type":"structure", + "members":{ + "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateHsmClientCertificateResult":{ + "type":"structure", + "members":{ + "HsmClientCertificate":{"shape":"HsmClientCertificate"} + } + }, + "CreateHsmConfigurationResult":{ + "type":"structure", + "members":{ + "HsmConfiguration":{"shape":"HsmConfiguration"} + } + }, + "DeleteClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "DeleteClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "DescribeDefaultClusterParametersResult":{ + "type":"structure", + "members":{ + "DefaultClusterParameters":{"shape":"DefaultClusterParameters"} + } + }, + "DisableSnapshotCopyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "EnableSnapshotCopyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifyClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifyClusterSubnetGroupResult":{ + "type":"structure", + "members":{ + "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifySnapshotCopyRetentionPeriodResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "PurchaseReservedNodeOfferingResult":{ + "type":"structure", + "members":{ + "ReservedNode":{"shape":"ReservedNode"} + } + }, + "RebootClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "RestoreFromClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "RevokeClusterSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "RevokeSnapshotAccessResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "RotateEncryptionKeyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + } + } +} diff --git a/apis/redshift-2012-12-01.paginators.json b/apis/redshift-2012-12-01.paginators.json new file mode 100644 index 0000000000..03027de356 --- /dev/null +++ b/apis/redshift-2012-12-01.paginators.json @@ -0,0 +1,94 @@ +{ + "pagination": { + "DescribeClusterParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ParameterGroups" + }, + "DescribeClusterParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeClusterSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterSecurityGroups" + }, + "DescribeClusterSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Snapshots" + }, + "DescribeClusterSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterSubnetGroups" + }, + "DescribeClusterVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterVersions" + }, + "DescribeClusters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Clusters" + }, + "DescribeDefaultClusterParameters": { + "input_token": "Marker", + "output_token": "DefaultClusterParameters.Marker", + "limit_key": "MaxRecords", + "result_key": "DefaultClusterParameters.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeHsmClientCertificates": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "HsmClientCertificates" + }, + "DescribeHsmConfigurations": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "HsmConfigurations" + }, + "DescribeOrderableClusterOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableClusterOptions" + }, + "DescribeReservedNodeOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedNodeOfferings" + }, + "DescribeReservedNodes": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedNodes" + } + } +} diff --git a/apis/redshift-2012-12-01.waiters.json b/apis/redshift-2012-12-01.waiters.json new file mode 100644 index 0000000000..8235a1d53f --- /dev/null +++ b/apis/redshift-2012-12-01.waiters.json @@ -0,0 +1,43 @@ +{ + "waiters": { + "__default__": { + "acceptor_type": "output" + }, + "__ClusterState": { + "interval": 60, + "max_attempts": 30, + "operation": "DescribeClusters", + "acceptor_path": "Clusters[].ClusterStatus" + }, + "ClusterAvailable": { + "extends": "__ClusterState", + "ignore_errors": [ + "ClusterNotFound" + ], + "success_value": "available", + "failure_value": [ + "deleting" + ] + }, + "ClusterDeleted": { + "extends": "__ClusterState", + "success_type": "error", + "success_value": "ClusterNotFound", + "failure_value": [ + "creating", + "rebooting" + ] + }, + "SnapshotAvailable": { + "interval": 15, + "max_attempts": 20, + "operation": "DescribeClusterSnapshots", + "acceptor_path": "Snapshots[].Status", + "success_value": "available", + "failure_value": [ + "failed", + "deleted" + ] + } + } +} diff --git a/apis/route53-2013-04-01.api.json b/apis/route53-2013-04-01.api.json new file mode 100644 index 0000000000..90de1c4a0c --- /dev/null +++ b/apis/route53-2013-04-01.api.json @@ -0,0 +1,1144 @@ +{ + "metadata": { + "apiVersion": "2013-04-01", + "endpointPrefix": "route53", + "globalEndpoint": "route53.amazonaws.com", + "serviceAbbreviation": "Route 53", + "serviceFullName": "Amazon Route 53", + "signatureVersion": "v3https", + "protocol": "rest-xml" + }, + "operations": { + "ChangeResourceRecordSets": { + "http": { + "requestUri": "/2013-04-01/hostedzone/{Id}/rrset/" + }, + "input": { + "xmlOrder": [ + "HostedZoneId", + "ChangeBatch" + ], + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "locationName": "ChangeResourceRecordSetsRequest", + "type": "structure", + "required": [ + "HostedZoneId", + "ChangeBatch" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "ChangeBatch": { + "type": "structure", + "required": [ + "Changes" + ], + "members": { + "Comment": {}, + "Changes": { + "type": "list", + "member": { + "locationName": "Change", + "type": "structure", + "required": [ + "Action", + "ResourceRecordSet" + ], + "members": { + "Action": {}, + "ResourceRecordSet": { + "shape": "S8" + } + }, + "xmlOrder": [ + "Action", + "ResourceRecordSet" + ] + } + } + }, + "xmlOrder": [ + "Comment", + "Changes" + ] + } + } + }, + "output": { + "xmlOrder": [ + "ChangeInfo" + ], + "type": "structure", + "required": [ + "ChangeInfo" + ], + "members": { + "ChangeInfo": { + "shape": "Sr" + } + } + } + }, + "ChangeTagsForResource": { + "http": { + "requestUri": "/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input": { + "xmlOrder": [ + "ResourceType", + "ResourceId", + "AddTags", + "RemoveTagKeys" + ], + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "locationName": "ChangeTagsForResourceRequest", + "type": "structure", + "required": [ + "ResourceType", + "ResourceId" + ], + "members": { + "ResourceType": { + "location": "uri", + "locationName": "ResourceType" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + }, + "AddTags": { + "shape": "Sx" + }, + "RemoveTagKeys": { + "type": "list", + "member": { + "locationName": "Key" + } + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "CreateHealthCheck": { + "http": { + "requestUri": "/2013-04-01/healthcheck", + "responseCode": 201 + }, + "input": { + "xmlOrder": [ + "CallerReference", + "HealthCheckConfig" + ], + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "locationName": "CreateHealthCheckRequest", + "type": "structure", + "required": [ + "CallerReference", + "HealthCheckConfig" + ], + "members": { + "CallerReference": {}, + "HealthCheckConfig": { + "shape": "S15" + } + } + }, + "output": { + "xmlOrder": [ + "HealthCheck", + "Location" + ], + "type": "structure", + "required": [ + "HealthCheck", + "Location" + ], + "members": { + "HealthCheck": { + "shape": "S1f" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "CreateHostedZone": { + "http": { + "requestUri": "/2013-04-01/hostedzone", + "responseCode": 201 + }, + "input": { + "xmlOrder": [ + "Name", + "CallerReference", + "HostedZoneConfig" + ], + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "locationName": "CreateHostedZoneRequest", + "type": "structure", + "required": [ + "Name", + "CallerReference" + ], + "members": { + "Name": {}, + "CallerReference": {}, + "HostedZoneConfig": { + "shape": "S1k" + } + } + }, + "output": { + "xmlOrder": [ + "HostedZone", + "ChangeInfo", + "DelegationSet", + "Location" + ], + "type": "structure", + "required": [ + "HostedZone", + "ChangeInfo", + "DelegationSet", + "Location" + ], + "members": { + "HostedZone": { + "shape": "S1m" + }, + "ChangeInfo": { + "shape": "Sr" + }, + "DelegationSet": { + "shape": "S1o" + }, + "Location": { + "location": "header", + "locationName": "Location" + } + } + } + }, + "DeleteHealthCheck": { + "http": { + "method": "DELETE", + "requestUri": "/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input": { + "xmlOrder": [ + "HealthCheckId" + ], + "type": "structure", + "required": [ + "HealthCheckId" + ], + "members": { + "HealthCheckId": { + "location": "uri", + "locationName": "HealthCheckId" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DeleteHostedZone": { + "http": { + "method": "DELETE", + "requestUri": "/2013-04-01/hostedzone/{Id}" + }, + "input": { + "xmlOrder": [ + "Id" + ], + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "xmlOrder": [ + "ChangeInfo" + ], + "type": "structure", + "required": [ + "ChangeInfo" + ], + "members": { + "ChangeInfo": { + "shape": "Sr" + } + } + } + }, + "GetChange": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/change/{Id}" + }, + "input": { + "xmlOrder": [ + "Id" + ], + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "xmlOrder": [ + "ChangeInfo" + ], + "type": "structure", + "required": [ + "ChangeInfo" + ], + "members": { + "ChangeInfo": { + "shape": "Sr" + } + } + } + }, + "GetCheckerIpRanges": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/checkeripranges" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "CheckerIpRanges" + ], + "members": { + "CheckerIpRanges": { + "type": "list", + "member": {} + } + } + } + }, + "GetGeoLocation": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/geolocation" + }, + "input": { + "xmlOrder": [ + "ContinentCode", + "CountryCode", + "SubdivisionCode" + ], + "type": "structure", + "members": { + "ContinentCode": { + "location": "querystring", + "locationName": "continentcode" + }, + "CountryCode": { + "location": "querystring", + "locationName": "countrycode" + }, + "SubdivisionCode": { + "location": "querystring", + "locationName": "subdivisioncode" + } + } + }, + "output": { + "xmlOrder": [ + "GeoLocationDetails" + ], + "type": "structure", + "required": [ + "GeoLocationDetails" + ], + "members": { + "GeoLocationDetails": { + "shape": "S22" + } + } + } + }, + "GetHealthCheck": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input": { + "xmlOrder": [ + "HealthCheckId" + ], + "type": "structure", + "required": [ + "HealthCheckId" + ], + "members": { + "HealthCheckId": { + "location": "uri", + "locationName": "HealthCheckId" + } + } + }, + "output": { + "xmlOrder": [ + "HealthCheck" + ], + "type": "structure", + "required": [ + "HealthCheck" + ], + "members": { + "HealthCheck": { + "shape": "S1f" + } + } + } + }, + "GetHealthCheckCount": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/healthcheckcount" + }, + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "required": [ + "HealthCheckCount" + ], + "members": { + "HealthCheckCount": { + "type": "long" + } + } + } + }, + "GetHostedZone": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzone/{Id}" + }, + "input": { + "xmlOrder": [ + "Id" + ], + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "location": "uri", + "locationName": "Id" + } + } + }, + "output": { + "xmlOrder": [ + "HostedZone", + "DelegationSet" + ], + "type": "structure", + "required": [ + "HostedZone", + "DelegationSet" + ], + "members": { + "HostedZone": { + "shape": "S1m" + }, + "DelegationSet": { + "shape": "S1o" + } + } + } + }, + "ListGeoLocations": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/geolocations" + }, + "input": { + "xmlOrder": [ + "StartContinentCode", + "StartCountryCode", + "StartSubdivisionCode", + "MaxItems" + ], + "type": "structure", + "members": { + "StartContinentCode": { + "location": "querystring", + "locationName": "startcontinentcode" + }, + "StartCountryCode": { + "location": "querystring", + "locationName": "startcountrycode" + }, + "StartSubdivisionCode": { + "location": "querystring", + "locationName": "startsubdivisioncode" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "xmlOrder": [ + "GeoLocationDetailsList", + "IsTruncated", + "NextContinentCode", + "NextCountryCode", + "NextSubdivisionCode", + "MaxItems" + ], + "type": "structure", + "required": [ + "GeoLocationDetailsList", + "IsTruncated", + "MaxItems" + ], + "members": { + "GeoLocationDetailsList": { + "type": "list", + "member": { + "shape": "S22", + "locationName": "GeoLocationDetails" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "NextContinentCode": {}, + "NextCountryCode": {}, + "NextSubdivisionCode": {}, + "MaxItems": {} + } + } + }, + "ListHealthChecks": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/healthcheck" + }, + "input": { + "xmlOrder": [ + "Marker", + "MaxItems" + ], + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "xmlOrder": [ + "HealthChecks", + "Marker", + "IsTruncated", + "NextMarker", + "MaxItems" + ], + "type": "structure", + "required": [ + "HealthChecks", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members": { + "HealthChecks": { + "type": "list", + "member": { + "shape": "S1f", + "locationName": "HealthCheck" + } + }, + "Marker": {}, + "IsTruncated": { + "type": "boolean" + }, + "NextMarker": {}, + "MaxItems": {} + } + } + }, + "ListHostedZones": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzone" + }, + "input": { + "xmlOrder": [ + "Marker", + "MaxItems" + ], + "type": "structure", + "members": { + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "xmlOrder": [ + "HostedZones", + "Marker", + "IsTruncated", + "NextMarker", + "MaxItems" + ], + "type": "structure", + "required": [ + "HostedZones", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members": { + "HostedZones": { + "type": "list", + "member": { + "shape": "S1m", + "locationName": "HostedZone" + } + }, + "Marker": {}, + "IsTruncated": { + "type": "boolean" + }, + "NextMarker": {}, + "MaxItems": {} + } + } + }, + "ListResourceRecordSets": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/hostedzone/{Id}/rrset" + }, + "input": { + "xmlOrder": [ + "HostedZoneId", + "StartRecordName", + "StartRecordType", + "StartRecordIdentifier", + "MaxItems" + ], + "type": "structure", + "required": [ + "HostedZoneId" + ], + "members": { + "HostedZoneId": { + "location": "uri", + "locationName": "Id" + }, + "StartRecordName": { + "location": "querystring", + "locationName": "name" + }, + "StartRecordType": { + "location": "querystring", + "locationName": "type" + }, + "StartRecordIdentifier": { + "location": "querystring", + "locationName": "identifier" + }, + "MaxItems": { + "location": "querystring", + "locationName": "maxitems" + } + } + }, + "output": { + "xmlOrder": [ + "ResourceRecordSets", + "IsTruncated", + "NextRecordName", + "NextRecordType", + "NextRecordIdentifier", + "MaxItems" + ], + "type": "structure", + "required": [ + "ResourceRecordSets", + "IsTruncated", + "MaxItems" + ], + "members": { + "ResourceRecordSets": { + "type": "list", + "member": { + "shape": "S8", + "locationName": "ResourceRecordSet" + } + }, + "IsTruncated": { + "type": "boolean" + }, + "NextRecordName": {}, + "NextRecordType": {}, + "NextRecordIdentifier": {}, + "MaxItems": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input": { + "xmlOrder": [ + "ResourceType", + "ResourceId" + ], + "type": "structure", + "required": [ + "ResourceType", + "ResourceId" + ], + "members": { + "ResourceType": { + "location": "uri", + "locationName": "ResourceType" + }, + "ResourceId": { + "location": "uri", + "locationName": "ResourceId" + } + } + }, + "output": { + "xmlOrder": [ + "ResourceTagSet" + ], + "type": "structure", + "required": [ + "ResourceTagSet" + ], + "members": { + "ResourceTagSet": { + "shape": "S2u" + } + } + } + }, + "ListTagsForResources": { + "http": { + "requestUri": "/2013-04-01/tags/{ResourceType}" + }, + "input": { + "xmlOrder": [ + "ResourceType", + "ResourceIds" + ], + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "locationName": "ListTagsForResourcesRequest", + "type": "structure", + "required": [ + "ResourceType", + "ResourceIds" + ], + "members": { + "ResourceType": { + "location": "uri", + "locationName": "ResourceType" + }, + "ResourceIds": { + "type": "list", + "member": { + "locationName": "ResourceId" + } + } + } + }, + "output": { + "xmlOrder": [ + "ResourceTagSets" + ], + "type": "structure", + "required": [ + "ResourceTagSets" + ], + "members": { + "ResourceTagSets": { + "type": "list", + "member": { + "shape": "S2u", + "locationName": "ResourceTagSet" + } + } + } + } + }, + "UpdateHealthCheck": { + "http": { + "requestUri": "/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input": { + "xmlOrder": [ + "HealthCheckId", + "HealthCheckVersion", + "IPAddress", + "Port", + "ResourcePath", + "FullyQualifiedDomainName", + "SearchString", + "FailureThreshold" + ], + "xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "locationName": "UpdateHealthCheckRequest", + "type": "structure", + "required": [ + "HealthCheckId" + ], + "members": { + "HealthCheckId": { + "location": "uri", + "locationName": "HealthCheckId" + }, + "HealthCheckVersion": { + "type": "long" + }, + "IPAddress": {}, + "Port": { + "type": "integer" + }, + "ResourcePath": {}, + "FullyQualifiedDomainName": {}, + "SearchString": {}, + "FailureThreshold": { + "type": "integer" + } + } + }, + "output": { + "xmlOrder": [ + "HealthCheck" + ], + "type": "structure", + "required": [ + "HealthCheck" + ], + "members": { + "HealthCheck": { + "shape": "S1f" + } + } + } + } + }, + "shapes": { + "S8": { + "type": "structure", + "required": [ + "Name", + "Type" + ], + "members": { + "Name": {}, + "Type": {}, + "SetIdentifier": {}, + "Weight": { + "type": "long" + }, + "Region": {}, + "GeoLocation": { + "type": "structure", + "members": { + "ContinentCode": {}, + "CountryCode": {}, + "SubdivisionCode": {} + }, + "xmlOrder": [ + "ContinentCode", + "CountryCode", + "SubdivisionCode" + ] + }, + "Failover": {}, + "TTL": { + "type": "long" + }, + "ResourceRecords": { + "type": "list", + "member": { + "locationName": "ResourceRecord", + "type": "structure", + "required": [ + "Value" + ], + "members": { + "Value": {} + }, + "xmlOrder": [ + "Value" + ] + } + }, + "AliasTarget": { + "type": "structure", + "required": [ + "HostedZoneId", + "DNSName", + "EvaluateTargetHealth" + ], + "members": { + "HostedZoneId": {}, + "DNSName": {}, + "EvaluateTargetHealth": { + "type": "boolean" + } + }, + "xmlOrder": [ + "HostedZoneId", + "DNSName", + "EvaluateTargetHealth" + ] + }, + "HealthCheckId": {} + }, + "xmlOrder": [ + "Name", + "Type", + "SetIdentifier", + "Weight", + "Region", + "GeoLocation", + "Failover", + "TTL", + "ResourceRecords", + "AliasTarget", + "HealthCheckId" + ] + }, + "Sr": { + "type": "structure", + "required": [ + "Id", + "Status", + "SubmittedAt" + ], + "members": { + "Id": {}, + "Status": {}, + "SubmittedAt": { + "type": "timestamp" + }, + "Comment": {} + }, + "xmlOrder": [ + "Id", + "Status", + "SubmittedAt", + "Comment" + ] + }, + "Sx": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S15": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "IPAddress": {}, + "Port": { + "type": "integer" + }, + "Type": {}, + "ResourcePath": {}, + "FullyQualifiedDomainName": {}, + "SearchString": {}, + "RequestInterval": { + "type": "integer" + }, + "FailureThreshold": { + "type": "integer" + } + }, + "xmlOrder": [ + "IPAddress", + "Port", + "Type", + "ResourcePath", + "FullyQualifiedDomainName", + "SearchString", + "RequestInterval", + "FailureThreshold" + ] + }, + "S1f": { + "type": "structure", + "required": [ + "Id", + "CallerReference", + "HealthCheckConfig", + "HealthCheckVersion" + ], + "members": { + "Id": {}, + "CallerReference": {}, + "HealthCheckConfig": { + "shape": "S15" + }, + "HealthCheckVersion": { + "type": "long" + } + }, + "xmlOrder": [ + "Id", + "CallerReference", + "HealthCheckConfig", + "HealthCheckVersion" + ] + }, + "S1k": { + "type": "structure", + "members": { + "Comment": {} + }, + "xmlOrder": [ + "Comment" + ] + }, + "S1m": { + "type": "structure", + "required": [ + "Id", + "Name", + "CallerReference" + ], + "members": { + "Id": {}, + "Name": {}, + "CallerReference": {}, + "Config": { + "shape": "S1k" + }, + "ResourceRecordSetCount": { + "type": "long" + } + }, + "xmlOrder": [ + "Id", + "Name", + "CallerReference", + "Config", + "ResourceRecordSetCount" + ] + }, + "S1o": { + "type": "structure", + "required": [ + "NameServers" + ], + "members": { + "NameServers": { + "type": "list", + "member": { + "locationName": "NameServer" + } + } + }, + "xmlOrder": [ + "NameServers" + ] + }, + "S22": { + "type": "structure", + "members": { + "ContinentCode": {}, + "ContinentName": {}, + "CountryCode": {}, + "CountryName": {}, + "SubdivisionCode": {}, + "SubdivisionName": {} + }, + "xmlOrder": [ + "ContinentCode", + "ContinentName", + "CountryCode", + "CountryName", + "SubdivisionCode", + "SubdivisionName" + ] + }, + "S2u": { + "type": "structure", + "members": { + "ResourceType": {}, + "ResourceId": {}, + "Tags": { + "shape": "Sx" + } + } + } + } +} \ No newline at end of file diff --git a/apis/route53-2013-04-01.full.json b/apis/route53-2013-04-01.full.json new file mode 100644 index 0000000000..ab6db45bd9 --- /dev/null +++ b/apis/route53-2013-04-01.full.json @@ -0,0 +1,2493 @@ +{ + "metadata":{ + "apiVersion":"2013-04-01", + "endpointPrefix":"route53", + "globalEndpoint":"route53.amazonaws.com", + "serviceAbbreviation":"Route 53", + "serviceFullName":"Amazon Route 53", + "signatureVersion":"v3https", + "protocol":"rest-xml" + }, + "operations":{ + "ChangeResourceRecordSets":{ + "name":"ChangeResourceRecordSets", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/rrset/" + }, + "input":{ + "shape":"ChangeResourceRecordSetsRequest", + "documentation":"

A complex type that contains a change batch.

", + "xmlOrder":[ + "HostedZoneId", + "ChangeBatch" + ], + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, + "locationName":"ChangeResourceRecordSetsRequest" + }, + "output":{ + "shape":"ChangeResourceRecordSetsResponse", + "documentation":"

A complex type containing the response for the request.

", + "xmlOrder":["ChangeInfo"] + }, + "errors":[ + { + "shape":"NoSuchHostedZone", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"NoSuchHealthCheck", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The health check you are trying to get or delete does not exist.

" + }, + { + "shape":"InvalidChangeBatch", + "exception":true, + "documentation":"

This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.

" + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + { + "shape":"PriorRequestNotComplete", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request was rejected because Route 53 was still processing a prior request.

" + } + ], + "documentation":"

Use this action to create or change your authoritative DNS information. To use this action, send a POST request to the 2013-04-01/hostedzone/hosted Zone ID/rrset resource. The request body must include an XML document with a ChangeResourceRecordSetsRequest element.

Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API in the Amazon Route 53 Developer Guide.

Due to the nature of transactional changes, you cannot delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch error.

In response to a ChangeResourceRecordSets request, your DNS data is changed on all Route 53 DNS servers. Initially, the status of a change is PENDING. This means the change has not yet propagated to all the authoritative Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of INSYNC.

Note the following limitations on a ChangeResourceRecordSets request:

- A request cannot contain more than 100 Change elements.

- A request cannot contain more than 1000 ResourceRecord elements.

The sum of the number of characters (including spaces) in all Value elements in a request cannot exceed 32,000 characters.

" + }, + "ChangeTagsForResource":{ + "name":"ChangeTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input":{ + "shape":"ChangeTagsForResourceRequest", + "documentation":"

A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.

", + "xmlOrder":[ + "ResourceType", + "ResourceId", + "AddTags", + "RemoveTagKeys" + ], + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, + "locationName":"ChangeTagsForResourceRequest" + }, + "output":{ + "shape":"ChangeTagsForResourceResponse", + "documentation":"

Empty response for the request.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + { + "shape":"NoSuchHealthCheck", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The health check you are trying to get or delete does not exist.

" + }, + { + "shape":"PriorRequestNotComplete", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request was rejected because Route 53 was still processing a prior request.

" + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "CreateHealthCheck":{ + "name":"CreateHealthCheck", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/healthcheck", + "responseCode":201 + }, + "input":{ + "shape":"CreateHealthCheckRequest", + "documentation":"

>A complex type that contains information about the request to create a health check.

", + "xmlOrder":[ + "CallerReference", + "HealthCheckConfig" + ], + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, + "locationName":"CreateHealthCheckRequest" + }, + "output":{ + "shape":"CreateHealthCheckResponse", + "documentation":"

A complex type containing the response information for the new health check.

", + "xmlOrder":[ + "HealthCheck", + "Location" + ] + }, + "errors":[ + { + "shape":"TooManyHealthChecks", + "exception":true + }, + { + "shape":"HealthCheckAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The health check you are trying to create already exists. Route 53 returns this error when a health check has already been created with the specified CallerReference.

" + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ], + "documentation":"

This action creates a new health check.

To create a new health check, send a POST request to the 2013-04-01/healthcheck resource. The request body must include an XML document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.

" + }, + "CreateHostedZone":{ + "name":"CreateHostedZone", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone", + "responseCode":201 + }, + "input":{ + "shape":"CreateHostedZoneRequest", + "documentation":"

A complex type that contains information about the request to create a hosted zone.

", + "xmlOrder":[ + "Name", + "CallerReference", + "HostedZoneConfig" + ], + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, + "locationName":"CreateHostedZoneRequest" + }, + "output":{ + "shape":"CreateHostedZoneResponse", + "documentation":"

A complex type containing the response information for the new hosted zone.

", + "xmlOrder":[ + "HostedZone", + "ChangeInfo", + "DelegationSet", + "Location" + ] + }, + "errors":[ + { + "shape":"InvalidDomainName", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

This error indicates that the specified domain name is not valid.

" + }, + { + "shape":"HostedZoneAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The hosted zone you are trying to create already exists. Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.

" + }, + { + "shape":"TooManyHostedZones", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.

" + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + { + "shape":"DelegationSetNotAvailable", + "exception":true, + "documentation":"

Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Route 53 generates this error, you can request an increase to the limit on the Contact Us page.

" + } + ], + "documentation":"

This action creates a new hosted zone.

To create a new hosted zone, send a POST request to the 2013-04-01/hostedzone resource. The request body must include an XML document with a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse element that contains metadata about the hosted zone.

Route 53 automatically creates a default SOA record and four NS records for the zone. The NS records in the hosted zone are the name servers you give your registrar to delegate your domain to. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

When you create a zone, its initial status is PENDING. This means that it is not yet available on all DNS servers. The status of the zone changes to INSYNC when the NS and SOA records are available on all Route 53 DNS servers.

" + }, + "DeleteHealthCheck":{ + "name":"DeleteHealthCheck", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{ + "shape":"DeleteHealthCheckRequest", + "documentation":"

A complex type containing the request information for delete health check.

", + "xmlOrder":["HealthCheckId"] + }, + "output":{ + "shape":"DeleteHealthCheckResponse", + "documentation":"

Empty response for the request.

" + }, + "errors":[ + { + "shape":"NoSuchHealthCheck", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The health check you are trying to get or delete does not exist.

" + }, + { + "shape":"HealthCheckInUse", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.

" + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ], + "documentation":"

This action deletes a health check. To delete a health check, send a DELETE request to the 2013-04-01/healthcheck/health check ID resource.

You can delete a health check only if there are no resource record sets associated with this health check. If resource record sets are associated with this health check, you must disassociate them before you can delete your health check. If you try to delete a health check that is associated with resource record sets, Route 53 will deny your request with a HealthCheckInUse error. For information about disassociating the records from your health check, see ChangeResourceRecordSets." + }, + "DeleteHostedZone":{ + "name":"DeleteHostedZone", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/hostedzone/{Id}" + }, + "input":{ + "shape":"DeleteHostedZoneRequest", + "documentation":"

A complex type containing the response information for the delete request.

", + "xmlOrder":["Id"] + }, + "output":{ + "shape":"DeleteHostedZoneResponse", + "documentation":"

A complex type containing the response information for the request.

", + "xmlOrder":["ChangeInfo"] + }, + "errors":[ + { + "shape":"NoSuchHostedZone", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"HostedZoneNotEmpty", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.

" + }, + { + "shape":"PriorRequestNotComplete", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request was rejected because Route 53 was still processing a prior request.

" + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ], + "documentation":"

This action deletes a hosted zone. To delete a hosted zone, send a DELETE request to the 2013-04-01/hostedzone/hosted zone ID resource.

For more information about deleting a hosted zone, see Deleting a Hosted Zone in the Amazon Route 53 Developer Guide.

You can delete a hosted zone only if there are no resource record sets other than the default SOA record and NS resource record sets. If your hosted zone contains other resource record sets, you must delete them before you can delete your hosted zone. If you try to delete a hosted zone that contains other resource record sets, Route 53 will deny your request with a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets." + }, + "GetChange":{ + "name":"GetChange", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/change/{Id}" + }, + "input":{ + "shape":"GetChangeRequest", + "documentation":"

The input for a GetChange request.

", + "xmlOrder":["Id"] + }, + "output":{ + "shape":"GetChangeResponse", + "documentation":"

A complex type that contains the ChangeInfo element.

", + "xmlOrder":["ChangeInfo"] + }, + "errors":[ + { + "shape":"NoSuchChange", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ], + "documentation":"

This action returns the current status of a change batch request. The status is one of the following values:

- PENDING indicates that the changes in this request have not replicated to all Route 53 DNS servers. This is the initial status of all change batch requests.

- INSYNC indicates that the changes have replicated to all Amazon Route 53 DNS servers.

" + }, + "GetCheckerIpRanges":{ + "name":"GetCheckerIpRanges", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/checkeripranges" + }, + "input":{ + "shape":"GetCheckerIpRangesRequest", + "documentation":"

Empty request.

" + }, + "output":{ + "shape":"GetCheckerIpRangesResponse", + "documentation":"

A complex type that contains the CheckerIpRanges element.

" + }, + "documentation":"

To retrieve a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources, send a GET request to the 2013-04-01/checkeripranges resource. You can use these IP addresses to configure router and firewall rules to allow health checkers to check the health of your resources.

" + }, + "GetGeoLocation":{ + "name":"GetGeoLocation", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/geolocation" + }, + "input":{ + "shape":"GetGeoLocationRequest", + "documentation":"

A complex type that contains information about the request to get a geo location.

", + "xmlOrder":[ + "ContinentCode", + "CountryCode", + "SubdivisionCode" + ] + }, + "output":{ + "shape":"GetGeoLocationResponse", + "documentation":"

A complex type containing information about the specified geo location.

", + "xmlOrder":["GeoLocationDetails"] + }, + "errors":[ + { + "shape":"NoSuchGeoLocation", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The geo location you are trying to get does not exist.

" + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ] + }, + "GetHealthCheck":{ + "name":"GetHealthCheck", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{ + "shape":"GetHealthCheckRequest", + "documentation":"

A complex type that contains information about the request to get a health check.

", + "xmlOrder":["HealthCheckId"] + }, + "output":{ + "shape":"GetHealthCheckResponse", + "documentation":"

A complex type containing information about the specified health check.

", + "xmlOrder":["HealthCheck"] + }, + "errors":[ + { + "shape":"NoSuchHealthCheck", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The health check you are trying to get or delete does not exist.

" + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + { + "shape":"IncompatibleVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.

" + } + ], + "documentation":"

To retrieve the health check, send a GET request to the 2013-04-01/healthcheck/health check ID resource.

" + }, + "GetHealthCheckCount":{ + "name":"GetHealthCheckCount", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheckcount" + }, + "input":{ + "shape":"GetHealthCheckCountRequest", + "documentation":"

To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.

" + }, + "output":{ + "shape":"GetHealthCheckCountResponse", + "documentation":"

A complex type that contains the count of health checks associated with the current AWS account.

" + }, + "documentation":"

To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.

" + }, + "GetHostedZone":{ + "name":"GetHostedZone", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}" + }, + "input":{ + "shape":"GetHostedZoneRequest", + "documentation":"

The input for a GetHostedZone request.

", + "xmlOrder":["Id"] + }, + "output":{ + "shape":"GetHostedZoneResponse", + "documentation":"

A complex type containing information about the specified hosted zone.

", + "xmlOrder":[ + "HostedZone", + "DelegationSet" + ] + }, + "errors":[ + { + "shape":"NoSuchHostedZone", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ], + "documentation":"

To retrieve the delegation set for a hosted zone, send a GET request to the 2013-04-01/hostedzone/hosted zone ID resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it.

" + }, + "ListGeoLocations":{ + "name":"ListGeoLocations", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/geolocations" + }, + "input":{ + "shape":"ListGeoLocationsRequest", + "documentation":"

The input for a ListGeoLocations request.

", + "xmlOrder":[ + "StartContinentCode", + "StartCountryCode", + "StartSubdivisionCode", + "MaxItems" + ] + }, + "output":{ + "shape":"ListGeoLocationsResponse", + "documentation":"

A complex type that contains information about the geo locations that are returned by the request and information about the response.

", + "xmlOrder":[ + "GeoLocationDetailsList", + "IsTruncated", + "NextContinentCode", + "NextCountryCode", + "NextSubdivisionCode", + "MaxItems" + ] + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ] + }, + "ListHealthChecks":{ + "name":"ListHealthChecks", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck" + }, + "input":{ + "shape":"ListHealthChecksRequest", + "documentation":"

To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero or more HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

", + "xmlOrder":[ + "Marker", + "MaxItems" + ] + }, + "output":{ + "shape":"ListHealthChecksResponse", + "documentation":"

A complex type that contains the response for the request.

", + "xmlOrder":[ + "HealthChecks", + "Marker", + "IsTruncated", + "NextMarker", + "MaxItems" + ] + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + { + "shape":"IncompatibleVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.

" + } + ], + "documentation":"

To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

" + }, + "ListHostedZones":{ + "name":"ListHostedZones", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone" + }, + "input":{ + "shape":"ListHostedZonesRequest", + "documentation":"

To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with. For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.

", + "xmlOrder":[ + "Marker", + "MaxItems" + ] + }, + "output":{ + "shape":"ListHostedZonesResponse", + "documentation":"

A complex type that contains the response for the request.

", + "xmlOrder":[ + "HostedZones", + "Marker", + "IsTruncated", + "NextMarker", + "MaxItems" + ] + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ], + "documentation":"

To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero, one, or multiple HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with.

" + }, + "ListResourceRecordSets":{ + "name":"ListResourceRecordSets", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}/rrset" + }, + "input":{ + "shape":"ListResourceRecordSetsRequest", + "documentation":"

The input for a ListResourceRecordSets request.

", + "xmlOrder":[ + "HostedZoneId", + "StartRecordName", + "StartRecordType", + "StartRecordIdentifier", + "MaxItems" + ] + }, + "output":{ + "shape":"ListResourceRecordSetsResponse", + "documentation":"

A complex type that contains information about the resource record sets that are returned by the request and information about the response.

", + "xmlOrder":[ + "ResourceRecordSets", + "IsTruncated", + "NextRecordName", + "NextRecordType", + "NextRecordIdentifier", + "MaxItems" + ] + }, + "errors":[ + { + "shape":"NoSuchHostedZone", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + } + ], + "documentation":"

Imagine all the resource record sets in a zone listed out in front of you. Imagine them sorted lexicographically first by DNS name (with the labels reversed, like \"com.amazon.www\" for example), and secondarily, lexicographically by record type. This operation retrieves at most MaxItems resource record sets from this list, in order, starting at a position specified by the Name and Type arguments:

Use ListResourceRecordSets to retrieve a single known record set by specifying the record set's name and type, and setting MaxItems = 1

To retrieve all the records in a HostedZone, first pause any processes making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets without a Name and Type to get the first page of record sets. For subsequent calls, set Name and Type to the NextName and NextType values returned by the previous response.

In the presence of concurrent ChangeResourceRecordSets calls, there is no consistency of results across calls to ListResourceRecordSets. The only way to get a consistent multi-page snapshot of all RRSETs in a zone is to stop making changes while pagination is in progress.

However, the results from ListResourceRecordSets are consistent within a page. If MakeChange calls are taking place concurrently, the result of each one will either be completely visible in your results or not at all. You will not see partial changes, or changes that do not ultimately succeed. (This follows from the fact that MakeChange is atomic)

The results from ListResourceRecordSets are strongly consistent with ChangeResourceRecordSets. To be precise, if a single process makes a call to ChangeResourceRecordSets and receives a successful response, the effects of that change will be visible in a subsequent call to ListResourceRecordSets by that process.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input":{ + "shape":"ListTagsForResourceRequest", + "documentation":"

A complex type containing information about a request for a list of the tags that are associated with an individual resource.

", + "xmlOrder":[ + "ResourceType", + "ResourceId" + ] + }, + "output":{ + "shape":"ListTagsForResourceResponse", + "documentation":"

A complex type containing tags for the specified resource.

", + "xmlOrder":["ResourceTagSet"] + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + { + "shape":"NoSuchHealthCheck", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The health check you are trying to get or delete does not exist.

" + }, + { + "shape":"PriorRequestNotComplete", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request was rejected because Route 53 was still processing a prior request.

" + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "ListTagsForResources":{ + "name":"ListTagsForResources", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/tags/{ResourceType}" + }, + "input":{ + "shape":"ListTagsForResourcesRequest", + "documentation":"

A complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.

", + "xmlOrder":[ + "ResourceType", + "ResourceIds" + ], + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, + "locationName":"ListTagsForResourcesRequest" + }, + "output":{ + "shape":"ListTagsForResourcesResponse", + "documentation":"

A complex type containing tags for the specified resources.

", + "xmlOrder":["ResourceTagSets"] + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + { + "shape":"NoSuchHealthCheck", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The health check you are trying to get or delete does not exist.

" + }, + { + "shape":"PriorRequestNotComplete", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request was rejected because Route 53 was still processing a prior request.

" + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "UpdateHealthCheck":{ + "name":"UpdateHealthCheck", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{ + "shape":"UpdateHealthCheckRequest", + "documentation":"

>A complex type that contains information about the request to update a health check.

", + "xmlOrder":[ + "HealthCheckId", + "HealthCheckVersion", + "IPAddress", + "Port", + "ResourcePath", + "FullyQualifiedDomainName", + "SearchString", + "FailureThreshold" + ], + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, + "locationName":"UpdateHealthCheckRequest" + }, + "output":{ + "shape":"UpdateHealthCheckResponse", + "xmlOrder":["HealthCheck"] + }, + "errors":[ + { + "shape":"NoSuchHealthCheck", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The health check you are trying to get or delete does not exist.

" + }, + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + { + "shape":"HealthCheckVersionMismatch", + "error":{"httpStatusCode":409}, + "exception":true + } + ], + "documentation":"

This action updates an existing health check.

To update a health check, send a POST request to the 2013-05-27/healthcheck/health check ID resource. The request body must include an XML document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.

" + } + }, + "shapes":{ + "AliasHealthEnabled":{"type":"boolean"}, + "AliasTarget":{ + "type":"structure", + "required":[ + "HostedZoneId", + "DNSName", + "EvaluateTargetHealth" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

Alias resource record sets only: The value of the hosted zone ID for the AWS resource.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

." + }, + "DNSName":{ + "shape":"DNSName", + "documentation":"

Alias resource record sets only: The external DNS name associated with the AWS Resource.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

." + }, + "EvaluateTargetHealth":{ + "shape":"AliasHealthEnabled", + "documentation":"

Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

." + } + }, + "documentation":"

Alias resource record sets only: Information about the domain to which you are redirecting traffic.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.", + "xmlOrder":[ + "HostedZoneId", + "DNSName", + "EvaluateTargetHealth" + ] + }, + "Change":{ + "type":"structure", + "required":[ + "Action", + "ResourceRecordSet" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

The action to perform.

Valid values: CREATE | DELETE | UPSERT

" + }, + "ResourceRecordSet":{ + "shape":"ResourceRecordSet", + "documentation":"

Information about the resource record set to create or delete.

" + } + }, + "documentation":"

A complex type that contains the information for each change in a change batch request.

", + "xmlOrder":[ + "Action", + "ResourceRecordSet" + ] + }, + "ChangeAction":{ + "type":"string", + "enum":[ + "CREATE", + "DELETE", + "UPSERT" + ] + }, + "ChangeBatch":{ + "type":"structure", + "required":["Changes"], + "members":{ + "Comment":{ + "shape":"ResourceDescription", + "documentation":"

Optional: Any comments you want to include about a change batch request.

" + }, + "Changes":{ + "shape":"Changes", + "documentation":"

A complex type that contains one Change element for each resource record set that you want to create or delete.

" + } + }, + "documentation":"

A complex type that contains an optional comment and the changes that you want to make with a change batch request.

", + "xmlOrder":[ + "Comment", + "Changes" + ] + }, + "ChangeInfo":{ + "type":"structure", + "required":[ + "Id", + "Status", + "SubmittedAt" + ], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

" + }, + "Status":{ + "shape":"ChangeStatus", + "documentation":"

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

Valid Values: PENDING | INSYNC

" + }, + "SubmittedAt":{ + "shape":"TimeStamp", + "documentation":"

The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

" + }, + "Comment":{ + "shape":"ResourceDescription", + "documentation":"

A complex type that describes change information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

" + } + }, + "documentation":"

A complex type that describes change information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

", + "xmlOrder":[ + "Id", + "Status", + "SubmittedAt", + "Comment" + ] + }, + "ChangeResourceRecordSetsRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "ChangeBatch" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id", + "documentation":"

The ID of the hosted zone that contains the resource record sets that you want to change.

" + }, + "ChangeBatch":{ + "shape":"ChangeBatch", + "documentation":"

A complex type that contains an optional comment and the Changes element.

" + } + }, + "documentation":"

A complex type that contains a change batch.

", + "xmlOrder":[ + "HostedZoneId", + "ChangeBatch" + ] + }, + "ChangeResourceRecordSetsResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

A complex type that contains information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

" + } + }, + "documentation":"

A complex type containing the response for the request.

", + "xmlOrder":["ChangeInfo"] + }, + "ChangeStatus":{ + "type":"string", + "enum":[ + "PENDING", + "INSYNC" + ] + }, + "ChangeTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "location":"uri", + "locationName":"ResourceType", + "documentation":"

The type of the resource. The resource type for health checks is healthcheck.

" + }, + "ResourceId":{ + "shape":"TagResourceId", + "location":"uri", + "locationName":"ResourceId", + "documentation":"

The ID of the resource for which you want to add, change, or delete tags.

" + }, + "AddTags":{ + "shape":"TagList", + "documentation":"

A complex type that contains a list of Tag elements. Each Tag element identifies a tag that you want to add or update for the specified resource.

" + }, + "RemoveTagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of Tag keys that you want to remove from the specified resource.

" + } + }, + "documentation":"

A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.

", + "xmlOrder":[ + "ResourceType", + "ResourceId", + "AddTags", + "RemoveTagKeys" + ] + }, + "ChangeTagsForResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Empty response for the request.

" + }, + "Changes":{ + "type":"list", + "member":{ + "shape":"Change", + "locationName":"Change" + }, + "min":1 + }, + "CheckerIpRanges":{ + "type":"list", + "member":{"shape":"IPAddressCidr"} + }, + "CreateHealthCheckRequest":{ + "type":"structure", + "required":[ + "CallerReference", + "HealthCheckConfig" + ], + "members":{ + "CallerReference":{ + "shape":"HealthCheckNonce", + "documentation":"

A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.

Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

" + }, + "HealthCheckConfig":{ + "shape":"HealthCheckConfig", + "documentation":"

A complex type that contains health check configuration.

" + } + }, + "documentation":"

>A complex type that contains information about the request to create a health check.

", + "xmlOrder":[ + "CallerReference", + "HealthCheckConfig" + ] + }, + "CreateHealthCheckResponse":{ + "type":"structure", + "required":[ + "HealthCheck", + "Location" + ], + "members":{ + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

A complex type that contains identifying information about the health check.

" + }, + "Location":{ + "shape":"ResourceURI", + "location":"header", + "locationName":"Location", + "documentation":"

The unique URL representing the new health check.

" + } + }, + "documentation":"

A complex type containing the response information for the new health check.

", + "xmlOrder":[ + "HealthCheck", + "Location" + ] + }, + "CreateHostedZoneRequest":{ + "type":"structure", + "required":[ + "Name", + "CallerReference" + ], + "members":{ + "Name":{ + "shape":"DNSName", + "documentation":"

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

" + }, + "CallerReference":{ + "shape":"Nonce", + "documentation":"

A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.

Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

" + }, + "HostedZoneConfig":{ + "shape":"HostedZoneConfig", + "documentation":"

A complex type that contains an optional comment about your hosted zone.

" + } + }, + "documentation":"

A complex type that contains information about the request to create a hosted zone.

", + "xmlOrder":[ + "Name", + "CallerReference", + "HostedZoneConfig" + ] + }, + "CreateHostedZoneResponse":{ + "type":"structure", + "required":[ + "HostedZone", + "ChangeInfo", + "DelegationSet", + "Location" + ], + "members":{ + "HostedZone":{ + "shape":"HostedZone", + "documentation":"

A complex type that contains identifying information about the hosted zone.

" + }, + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.

" + }, + "DelegationSet":{ + "shape":"DelegationSet", + "documentation":"

A complex type that contains name server information.

" + }, + "Location":{ + "shape":"ResourceURI", + "location":"header", + "locationName":"Location", + "documentation":"

The unique URL representing the new hosted zone.

" + } + }, + "documentation":"

A complex type containing the response information for the new hosted zone.

", + "xmlOrder":[ + "HostedZone", + "ChangeInfo", + "DelegationSet", + "Location" + ] + }, + "DNSName":{ + "type":"string", + "max":1024 + }, + "DelegationSet":{ + "type":"structure", + "required":["NameServers"], + "members":{ + "NameServers":{ + "shape":"DelegationSetNameServers", + "documentation":"

A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.

" + } + }, + "documentation":"

A complex type that contains name server information.

", + "xmlOrder":["NameServers"] + }, + "DelegationSetNameServers":{ + "type":"list", + "member":{ + "shape":"DNSName", + "locationName":"NameServer" + }, + "min":1 + }, + "DelegationSetNotAvailable":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "exception":true, + "documentation":"

Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Route 53 generates this error, you can request an increase to the limit on the Contact Us page.

" + }, + "DeleteHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "location":"uri", + "locationName":"HealthCheckId", + "documentation":"

The ID of the health check to delete.

" + } + }, + "documentation":"

A complex type containing the request information for delete health check.

", + "xmlOrder":["HealthCheckId"] + }, + "DeleteHealthCheckResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Empty response for the request.

" + }, + "DeleteHostedZoneRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id", + "documentation":"

The ID of the request. Include this ID in a call to GetChange to track when the change has propagated to all Route 53 DNS servers.

" + } + }, + "documentation":"

A complex type containing the response information for the delete request.

", + "xmlOrder":["Id"] + }, + "DeleteHostedZoneResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

A complex type that contains the ID, the status, and the date and time of your delete request.

" + } + }, + "documentation":"

A complex type containing the response information for the request.

", + "xmlOrder":["ChangeInfo"] + }, + "ErrorMessage":{"type":"string"}, + "ErrorMessages":{ + "type":"list", + "member":{ + "shape":"ErrorMessage", + "locationName":"Message" + } + }, + "FailureThreshold":{ + "type":"integer", + "min":1, + "max":10 + }, + "FullyQualifiedDomainName":{ + "type":"string", + "max":255 + }, + "GeoLocation":{ + "type":"structure", + "members":{ + "ContinentCode":{ + "shape":"GeoLocationContinentCode", + "documentation":"

The code for a continent geo location. Note: only continent locations have a continent code.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

" + }, + "CountryCode":{ + "shape":"GeoLocationCountryCode", + "documentation":"

The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

" + }, + "SubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "documentation":"

The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

" + } + }, + "documentation":"

A complex type that contains information about a geo location.

", + "xmlOrder":[ + "ContinentCode", + "CountryCode", + "SubdivisionCode" + ] + }, + "GeoLocationContinentCode":{ + "type":"string", + "min":2, + "max":2 + }, + "GeoLocationContinentName":{ + "type":"string", + "min":1, + "max":32 + }, + "GeoLocationCountryCode":{ + "type":"string", + "min":1, + "max":2 + }, + "GeoLocationCountryName":{ + "type":"string", + "min":1, + "max":64 + }, + "GeoLocationDetails":{ + "type":"structure", + "members":{ + "ContinentCode":{ + "shape":"GeoLocationContinentCode", + "documentation":"

The code for a continent geo location. Note: only continent locations have a continent code.

" + }, + "ContinentName":{ + "shape":"GeoLocationContinentName", + "documentation":"

The name of the continent. This element is only present if ContinentCode is also present.

" + }, + "CountryCode":{ + "shape":"GeoLocationCountryCode", + "documentation":"

The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

" + }, + "CountryName":{ + "shape":"GeoLocationCountryName", + "documentation":"

The name of the country. This element is only present if CountryCode is also present.

" + }, + "SubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "documentation":"

The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

" + }, + "SubdivisionName":{ + "shape":"GeoLocationSubdivisionName", + "documentation":"

The name of the subdivision. This element is only present if SubdivisionCode is also present.

" + } + }, + "documentation":"

A complex type that contains information about a GeoLocation.

", + "xmlOrder":[ + "ContinentCode", + "ContinentName", + "CountryCode", + "CountryName", + "SubdivisionCode", + "SubdivisionName" + ] + }, + "GeoLocationDetailsList":{ + "type":"list", + "member":{ + "shape":"GeoLocationDetails", + "locationName":"GeoLocationDetails" + } + }, + "GeoLocationSubdivisionCode":{ + "type":"string", + "min":1, + "max":3 + }, + "GeoLocationSubdivisionName":{ + "type":"string", + "min":1, + "max":64 + }, + "GetChangeRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id", + "documentation":"

The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

" + } + }, + "documentation":"

The input for a GetChange request.

", + "xmlOrder":["Id"] + }, + "GetChangeResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.

" + } + }, + "documentation":"

A complex type that contains the ChangeInfo element.

", + "xmlOrder":["ChangeInfo"] + }, + "GetCheckerIpRangesRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

Empty request.

" + }, + "GetCheckerIpRangesResponse":{ + "type":"structure", + "required":["CheckerIpRanges"], + "members":{ + "CheckerIpRanges":{ + "shape":"CheckerIpRanges", + "documentation":"

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.

" + } + }, + "documentation":"

A complex type that contains the CheckerIpRanges element.

" + }, + "GetGeoLocationRequest":{ + "type":"structure", + "members":{ + "ContinentCode":{ + "shape":"GeoLocationContinentCode", + "location":"querystring", + "locationName":"continentcode", + "documentation":"

The code for a continent geo location. Note: only continent locations have a continent code.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

" + }, + "CountryCode":{ + "shape":"GeoLocationCountryCode", + "location":"querystring", + "locationName":"countrycode", + "documentation":"

The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

" + }, + "SubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "location":"querystring", + "locationName":"subdivisioncode", + "documentation":"

The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

" + } + }, + "documentation":"

A complex type that contains information about the request to get a geo location.

", + "xmlOrder":[ + "ContinentCode", + "CountryCode", + "SubdivisionCode" + ] + }, + "GetGeoLocationResponse":{ + "type":"structure", + "required":["GeoLocationDetails"], + "members":{ + "GeoLocationDetails":{ + "shape":"GeoLocationDetails", + "documentation":"

A complex type that contains the information about the specified geo location.

" + } + }, + "documentation":"

A complex type containing information about the specified geo location.

", + "xmlOrder":["GeoLocationDetails"] + }, + "GetHealthCheckCountRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.

" + }, + "GetHealthCheckCountResponse":{ + "type":"structure", + "required":["HealthCheckCount"], + "members":{ + "HealthCheckCount":{ + "shape":"HealthCheckCount", + "documentation":"

The number of health checks associated with the current AWS account.

" + } + }, + "documentation":"

A complex type that contains the count of health checks associated with the current AWS account.

" + }, + "GetHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "location":"uri", + "locationName":"HealthCheckId", + "documentation":"

The ID of the health check to retrieve.

" + } + }, + "documentation":"

A complex type that contains information about the request to get a health check.

", + "xmlOrder":["HealthCheckId"] + }, + "GetHealthCheckResponse":{ + "type":"structure", + "required":["HealthCheck"], + "members":{ + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

A complex type that contains the information about the specified health check.

" + } + }, + "documentation":"

A complex type containing information about the specified health check.

", + "xmlOrder":["HealthCheck"] + }, + "GetHostedZoneRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id", + "documentation":"

The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.

" + } + }, + "documentation":"

The input for a GetHostedZone request.

", + "xmlOrder":["Id"] + }, + "GetHostedZoneResponse":{ + "type":"structure", + "required":[ + "HostedZone", + "DelegationSet" + ], + "members":{ + "HostedZone":{ + "shape":"HostedZone", + "documentation":"

A complex type that contains the information about the specified hosted zone.

" + }, + "DelegationSet":{ + "shape":"DelegationSet", + "documentation":"

A complex type that contains information about the name servers for the specified hosted zone.

" + } + }, + "documentation":"

A complex type containing information about the specified hosted zone.

", + "xmlOrder":[ + "HostedZone", + "DelegationSet" + ] + }, + "HealthCheck":{ + "type":"structure", + "required":[ + "Id", + "CallerReference", + "HealthCheckConfig", + "HealthCheckVersion" + ], + "members":{ + "Id":{ + "shape":"HealthCheckId", + "documentation":"

The ID of the specified health check.

" + }, + "CallerReference":{ + "shape":"HealthCheckNonce", + "documentation":"

A unique string that identifies the request to create the health check.

" + }, + "HealthCheckConfig":{ + "shape":"HealthCheckConfig", + "documentation":"

A complex type that contains the health check configuration.

" + }, + "HealthCheckVersion":{ + "shape":"HealthCheckVersion", + "documentation":"

The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

" + } + }, + "documentation":"

A complex type that contains identifying information about the health check.

", + "xmlOrder":[ + "Id", + "CallerReference", + "HealthCheckConfig", + "HealthCheckVersion" + ] + }, + "HealthCheckAlreadyExists":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The health check you are trying to create already exists. Route 53 returns this error when a health check has already been created with the specified CallerReference.

" + }, + "HealthCheckConfig":{ + "type":"structure", + "required":["Type"], + "members":{ + "IPAddress":{ + "shape":"IPAddress", + "documentation":"

IP Address of the instance being checked.

" + }, + "Port":{ + "shape":"Port", + "documentation":"

Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.

" + }, + "Type":{ + "shape":"HealthCheckType", + "documentation":"

The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.

" + }, + "ResourcePath":{ + "shape":"ResourcePath", + "documentation":"

Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.

" + }, + "FullyQualifiedDomainName":{ + "shape":"FullyQualifiedDomainName", + "documentation":"

Fully qualified domain name of the instance to be health checked.

" + }, + "SearchString":{ + "shape":"SearchString", + "documentation":"

A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.

" + }, + "RequestInterval":{ + "shape":"RequestInterval", + "documentation":"

The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.

Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.

" + }, + "FailureThreshold":{ + "shape":"FailureThreshold", + "documentation":"

The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.

Valid values are integers between 1 and 10. For more information, see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the Amazon Route 53 Developer Guide.

" + } + }, + "documentation":"

A complex type that contains the health check configuration.

", + "xmlOrder":[ + "IPAddress", + "Port", + "Type", + "ResourcePath", + "FullyQualifiedDomainName", + "SearchString", + "RequestInterval", + "FailureThreshold" + ] + }, + "HealthCheckCount":{"type":"long"}, + "HealthCheckId":{ + "type":"string", + "max":64 + }, + "HealthCheckInUse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.

" + }, + "HealthCheckNonce":{ + "type":"string", + "min":1, + "max":64 + }, + "HealthCheckType":{ + "type":"string", + "enum":[ + "HTTP", + "HTTPS", + "HTTP_STR_MATCH", + "HTTPS_STR_MATCH", + "TCP" + ] + }, + "HealthCheckVersion":{ + "type":"long", + "min":1 + }, + "HealthCheckVersionMismatch":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "HealthChecks":{ + "type":"list", + "member":{ + "shape":"HealthCheck", + "locationName":"HealthCheck" + } + }, + "HostedZone":{ + "type":"structure", + "required":[ + "Id", + "Name", + "CallerReference" + ], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

The ID of the specified hosted zone.

" + }, + "Name":{ + "shape":"DNSName", + "documentation":"

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

" + }, + "CallerReference":{ + "shape":"Nonce", + "documentation":"

A unique string that identifies the request to create the hosted zone.

" + }, + "Config":{ + "shape":"HostedZoneConfig", + "documentation":"

A complex type that contains the Comment element.

" + }, + "ResourceRecordSetCount":{ + "shape":"HostedZoneRRSetCount", + "documentation":"

Total number of resource record sets in the hosted zone.

" + } + }, + "documentation":"

A complex type that contain information about the specified hosted zone.

", + "xmlOrder":[ + "Id", + "Name", + "CallerReference", + "Config", + "ResourceRecordSetCount" + ] + }, + "HostedZoneAlreadyExists":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"

The hosted zone you are trying to create already exists. Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.

" + }, + "HostedZoneConfig":{ + "type":"structure", + "members":{ + "Comment":{ + "shape":"ResourceDescription", + "documentation":"

An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

" + } + }, + "documentation":"

A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

", + "xmlOrder":["Comment"] + }, + "HostedZoneNotEmpty":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.

" + }, + "HostedZoneRRSetCount":{"type":"long"}, + "HostedZones":{ + "type":"list", + "member":{ + "shape":"HostedZone", + "locationName":"HostedZone" + } + }, + "IPAddress":{ + "type":"string", + "max":15, + "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])$" + }, + "IPAddressCidr":{"type":"string"}, + "IncompatibleVersion":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.

" + }, + "InvalidChangeBatch":{ + "type":"structure", + "members":{ + "messages":{ + "shape":"ErrorMessages", + "documentation":"

Descriptive message for the error response.

" + } + }, + "exception":true, + "documentation":"

This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.

" + }, + "InvalidDomainName":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

This error indicates that the specified domain name is not valid.

" + }, + "InvalidInput":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Some value specified in the request is invalid or the XML document is malformed.

" + }, + "ListGeoLocationsRequest":{ + "type":"structure", + "members":{ + "StartContinentCode":{ + "shape":"GeoLocationContinentCode", + "location":"querystring", + "locationName":"startcontinentcode", + "documentation":"

The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

" + }, + "StartCountryCode":{ + "shape":"GeoLocationCountryCode", + "location":"querystring", + "locationName":"startcountrycode", + "documentation":"

The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

" + }, + "StartSubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "location":"querystring", + "locationName":"startsubdivisioncode", + "documentation":"

The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems", + "documentation":"

The maximum number of geo locations you want in the response body.

" + } + }, + "documentation":"

The input for a ListGeoLocations request.

", + "xmlOrder":[ + "StartContinentCode", + "StartCountryCode", + "StartSubdivisionCode", + "MaxItems" + ] + }, + "ListGeoLocationsResponse":{ + "type":"structure", + "required":[ + "GeoLocationDetailsList", + "IsTruncated", + "MaxItems" + ], + "members":{ + "GeoLocationDetailsList":{ + "shape":"GeoLocationDetailsList", + "documentation":"

A complex type that contains information about the geo locations that are returned by the request.

" + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the ListGeoLocationsResponse$NextContinentCode, ListGeoLocationsResponse$NextCountryCode and ListGeoLocationsResponse$NextSubdivisionCode elements.

Valid Values: true | false

" + }, + "NextContinentCode":{ + "shape":"GeoLocationContinentCode", + "documentation":"

If the results were truncated, the continent code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is a continent location.

" + }, + "NextCountryCode":{ + "shape":"GeoLocationCountryCode", + "documentation":"

If the results were truncated, the country code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is not a continent location.

" + }, + "NextSubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "documentation":"

If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location has a subdivision.

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

The maximum number of records you requested. The maximum value of MaxItems is 100.

" + } + }, + "documentation":"

A complex type that contains information about the geo locations that are returned by the request and information about the response.

", + "xmlOrder":[ + "GeoLocationDetailsList", + "IsTruncated", + "NextContinentCode", + "NextCountryCode", + "NextSubdivisionCode", + "MaxItems" + ] + }, + "ListHealthChecksRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "location":"querystring", + "locationName":"marker", + "documentation":"

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems", + "documentation":"

Specify the maximum number of health checks to return per page of results.

" + } + }, + "documentation":"

To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero or more HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

", + "xmlOrder":[ + "Marker", + "MaxItems" + ] + }, + "ListHealthChecksResponse":{ + "type":"structure", + "required":[ + "HealthChecks", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members":{ + "HealthChecks":{ + "shape":"HealthChecks", + "documentation":"

A complex type that contains information about the health checks associated with the current AWS account.

" + }, + "Marker":{ + "shape":"PageMarker", + "documentation":"

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

" + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

Valid Values: true | false

" + }, + "NextMarker":{ + "shape":"PageMarker", + "documentation":"

Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true, make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems, the value of ListHealthChecksResponse$IsTruncated in the response is true. Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.

" + } + }, + "documentation":"

A complex type that contains the response for the request.

", + "xmlOrder":[ + "HealthChecks", + "Marker", + "IsTruncated", + "NextMarker", + "MaxItems" + ] + }, + "ListHostedZonesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "location":"querystring", + "locationName":"marker", + "documentation":"

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems", + "documentation":"

Specify the maximum number of hosted zones to return per page of results.

" + } + }, + "documentation":"

To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with. For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.

", + "xmlOrder":[ + "Marker", + "MaxItems" + ] + }, + "ListHostedZonesResponse":{ + "type":"structure", + "required":[ + "HostedZones", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members":{ + "HostedZones":{ + "shape":"HostedZones", + "documentation":"

A complex type that contains information about the hosted zones associated with the current AWS account.

" + }, + "Marker":{ + "shape":"PageMarker", + "documentation":"

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

" + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

Valid Values: true | false

" + }, + "NextMarker":{ + "shape":"PageMarker", + "documentation":"

Indicates where to continue listing hosted zones. If ListHostedZonesResponse$IsTruncated is true, make another request to ListHostedZones and include the value of the NextMarker element in the Marker element to get the next page of results.

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesResponse$IsTruncated in the response is true. Call ListHostedZones again and specify the value of ListHostedZonesResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.

" + } + }, + "documentation":"

A complex type that contains the response for the request.

", + "xmlOrder":[ + "HostedZones", + "Marker", + "IsTruncated", + "NextMarker", + "MaxItems" + ] + }, + "ListResourceRecordSetsRequest":{ + "type":"structure", + "required":["HostedZoneId"], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id", + "documentation":"

The ID of the hosted zone that contains the resource record sets that you want to get.

" + }, + "StartRecordName":{ + "shape":"DNSName", + "location":"querystring", + "locationName":"name", + "documentation":"

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

" + }, + "StartRecordType":{ + "shape":"RRType", + "location":"querystring", + "locationName":"type", + "documentation":"

The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

Constraint: Specifying type without specifying name returns an InvalidInput error.

" + }, + "StartRecordIdentifier":{ + "shape":"ResourceRecordSetIdentifier", + "location":"querystring", + "locationName":"identifier", + "documentation":"

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems", + "documentation":"

The maximum number of records you want in the response body.

" + } + }, + "documentation":"

The input for a ListResourceRecordSets request.

", + "xmlOrder":[ + "HostedZoneId", + "StartRecordName", + "StartRecordType", + "StartRecordIdentifier", + "MaxItems" + ] + }, + "ListResourceRecordSetsResponse":{ + "type":"structure", + "required":[ + "ResourceRecordSets", + "IsTruncated", + "MaxItems" + ], + "members":{ + "ResourceRecordSets":{ + "shape":"ResourceRecordSets", + "documentation":"

A complex type that contains information about the resource record sets that are returned by the request.

" + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the ListResourceRecordSetsResponse$NextRecordName element.

Valid Values: true | false

" + }, + "NextRecordName":{ + "shape":"DNSName", + "documentation":"

If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.

" + }, + "NextRecordType":{ + "shape":"RRType", + "documentation":"

If the results were truncated, the type of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.

" + }, + "NextRecordIdentifier":{ + "shape":"ResourceRecordSetIdentifier", + "documentation":"

Weighted resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

The maximum number of records you requested. The maximum value of MaxItems is 100.

" + } + }, + "documentation":"

A complex type that contains information about the resource record sets that are returned by the request and information about the response.

", + "xmlOrder":[ + "ResourceRecordSets", + "IsTruncated", + "NextRecordName", + "NextRecordType", + "NextRecordIdentifier", + "MaxItems" + ] + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "location":"uri", + "locationName":"ResourceType", + "documentation":"

The type of the resource. The resource type for health checks is healthcheck.

" + }, + "ResourceId":{ + "shape":"TagResourceId", + "location":"uri", + "locationName":"ResourceId", + "documentation":"

The ID of the resource for which you want to retrieve tags.

" + } + }, + "documentation":"

A complex type containing information about a request for a list of the tags that are associated with an individual resource.

", + "xmlOrder":[ + "ResourceType", + "ResourceId" + ] + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["ResourceTagSet"], + "members":{ + "ResourceTagSet":{ + "shape":"ResourceTagSet", + "documentation":"

A ResourceTagSet containing tags associated with the specified resource.

" + } + }, + "documentation":"

A complex type containing tags for the specified resource.

", + "xmlOrder":["ResourceTagSet"] + }, + "ListTagsForResourcesRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceIds" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "location":"uri", + "locationName":"ResourceType", + "documentation":"

The type of the resources. The resource type for health checks is healthcheck.

" + }, + "ResourceIds":{ + "shape":"TagResourceIdList", + "documentation":"

A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

" + } + }, + "documentation":"

A complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.

", + "xmlOrder":[ + "ResourceType", + "ResourceIds" + ] + }, + "ListTagsForResourcesResponse":{ + "type":"structure", + "required":["ResourceTagSets"], + "members":{ + "ResourceTagSets":{ + "shape":"ResourceTagSetList", + "documentation":"

A list of ResourceTagSets containing tags associated with the specified resources.

" + } + }, + "documentation":"

A complex type containing tags for the specified resources.

", + "xmlOrder":["ResourceTagSets"] + }, + "NoSuchChange":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchGeoLocation":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The geo location you are trying to get does not exist.

" + }, + "NoSuchHealthCheck":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The health check you are trying to get or delete does not exist.

" + }, + "NoSuchHostedZone":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "Nonce":{ + "type":"string", + "min":1, + "max":128 + }, + "PageMarker":{ + "type":"string", + "max":64 + }, + "PageMaxItems":{"type":"string"}, + "PageTruncated":{"type":"boolean"}, + "Port":{ + "type":"integer", + "min":1, + "max":65535 + }, + "PriorRequestNotComplete":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request was rejected because Route 53 was still processing a prior request.

" + }, + "RData":{ + "type":"string", + "max":4000 + }, + "RRType":{ + "type":"string", + "enum":[ + "SOA", + "A", + "TXT", + "NS", + "CNAME", + "MX", + "PTR", + "SRV", + "SPF", + "AAAA" + ] + }, + "RequestInterval":{ + "type":"integer", + "min":10, + "max":30 + }, + "ResourceDescription":{ + "type":"string", + "max":256 + }, + "ResourceId":{ + "type":"string", + "max":32 + }, + "ResourcePath":{ + "type":"string", + "max":255 + }, + "ResourceRecord":{ + "type":"structure", + "required":["Value"], + "members":{ + "Value":{ + "shape":"RData", + "documentation":"

The value of the Value element for the current resource record set.

" + } + }, + "documentation":"

A complex type that contains the value of the Value element for the current resource record set.

", + "xmlOrder":["Value"] + }, + "ResourceRecordSet":{ + "type":"structure", + "required":[ + "Name", + "Type" + ], + "members":{ + "Name":{ + "shape":"DNSName", + "documentation":"

The domain name of the current resource record set.

" + }, + "Type":{ + "shape":"RRType", + "documentation":"

The type of the current resource record set.

" + }, + "SetIdentifier":{ + "shape":"ResourceRecordSetIdentifier", + "documentation":"

Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.

" + }, + "Weight":{ + "shape":"ResourceRecordSetWeight", + "documentation":"

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.

" + }, + "Region":{ + "shape":"ResourceRecordSetRegion", + "documentation":"

Latency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.

" + }, + "GeoLocation":{ + "shape":"GeoLocation", + "documentation":"

Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.

" + }, + "Failover":{ + "shape":"ResourceRecordSetFailover", + "documentation":"

Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.

Valid values: PRIMARY | SECONDARY

" + }, + "TTL":{ + "shape":"TTL", + "documentation":"

The cache time to live for the current resource record set.

" + }, + "ResourceRecords":{ + "shape":"ResourceRecords", + "documentation":"

A complex type that contains the resource records for the current resource record set.

" + }, + "AliasTarget":{ + "shape":"AliasTarget", + "documentation":"

Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.

" + }, + "HealthCheckId":{ + "shape":"HealthCheckId", + "documentation":"

Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.

" + } + }, + "documentation":"

A complex type that contains information about the current resource record set.

", + "xmlOrder":[ + "Name", + "Type", + "SetIdentifier", + "Weight", + "Region", + "GeoLocation", + "Failover", + "TTL", + "ResourceRecords", + "AliasTarget", + "HealthCheckId" + ] + }, + "ResourceRecordSetFailover":{ + "type":"string", + "enum":[ + "PRIMARY", + "SECONDARY" + ] + }, + "ResourceRecordSetIdentifier":{ + "type":"string", + "min":1, + "max":128 + }, + "ResourceRecordSetRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-west-1", + "us-west-2", + "eu-west-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "sa-east-1", + "cn-north-1" + ], + "min":1, + "max":64 + }, + "ResourceRecordSetWeight":{ + "type":"long", + "min":0, + "max":255 + }, + "ResourceRecordSets":{ + "type":"list", + "member":{ + "shape":"ResourceRecordSet", + "locationName":"ResourceRecordSet" + } + }, + "ResourceRecords":{ + "type":"list", + "member":{ + "shape":"ResourceRecord", + "locationName":"ResourceRecord" + }, + "min":1 + }, + "ResourceTagSet":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "documentation":"

The type of the resource. The resource type for health checks is healthcheck.

" + }, + "ResourceId":{ + "shape":"TagResourceId", + "documentation":"

The ID for the specified resource.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the specified resource.

" + } + }, + "documentation":"

A complex type containing a resource and its associated tags.

" + }, + "ResourceTagSetList":{ + "type":"list", + "member":{ + "shape":"ResourceTagSet", + "locationName":"ResourceTagSet" + } + }, + "ResourceURI":{ + "type":"string", + "max":1024 + }, + "SearchString":{ + "type":"string", + "max":255 + }, + "TTL":{ + "type":"long", + "min":0, + "max":2147483647 + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key for a Tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value for a Tag.

" + } + }, + "documentation":"

A single tag containing a key and value.

" + }, + "TagKey":{ + "type":"string", + "max":128 + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + }, + "min":1, + "max":10 + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + }, + "min":1, + "max":10 + }, + "TagResourceId":{ + "type":"string", + "max":64 + }, + "TagResourceIdList":{ + "type":"list", + "member":{ + "shape":"TagResourceId", + "locationName":"ResourceId" + }, + "min":1, + "max":10 + }, + "TagResourceType":{ + "type":"string", + "enum":["healthcheck"] + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TimeStamp":{"type":"timestamp"}, + "TooManyHealthChecks":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "TooManyHostedZones":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Descriptive message for the error response.

" + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.

" + }, + "UpdateHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "location":"uri", + "locationName":"HealthCheckId", + "documentation":"

The ID of the health check to update.

" + }, + "HealthCheckVersion":{ + "shape":"HealthCheckVersion", + "documentation":"

Optional. When you specify a health check version, Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.

" + }, + "IPAddress":{ + "shape":"IPAddress", + "documentation":"

The IP address of the resource that you want to check.

Specify this value only if you want to change it.

" + }, + "Port":{ + "shape":"Port", + "documentation":"

The port on which you want Route 53 to open a connection to perform health checks.

Specify this value only if you want to change it.

" + }, + "ResourcePath":{ + "shape":"ResourcePath", + "documentation":"

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.

Specify this value only if you want to change it.

" + }, + "FullyQualifiedDomainName":{ + "shape":"FullyQualifiedDomainName", + "documentation":"

Fully qualified domain name of the instance to be health checked.

Specify this value only if you want to change it.

" + }, + "SearchString":{ + "shape":"SearchString", + "documentation":"

If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.

Specify this value only if you want to change it.

" + }, + "FailureThreshold":{ + "shape":"FailureThreshold", + "documentation":"

The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.

Valid values are integers between 1 and 10. For more information, see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the Amazon Route 53 Developer Guide.

Specify this value only if you want to change it.

" + } + }, + "documentation":"

>A complex type that contains information about the request to update a health check.

", + "xmlOrder":[ + "HealthCheckId", + "HealthCheckVersion", + "IPAddress", + "Port", + "ResourcePath", + "FullyQualifiedDomainName", + "SearchString", + "FailureThreshold" + ] + }, + "UpdateHealthCheckResponse":{ + "type":"structure", + "required":["HealthCheck"], + "members":{ + "HealthCheck":{"shape":"HealthCheck"} + }, + "xmlOrder":["HealthCheck"] + } + } +} diff --git a/apis/route53-2013-04-01.paginators.json b/apis/route53-2013-04-01.paginators.json new file mode 100644 index 0000000000..d472f47a28 --- /dev/null +++ b/apis/route53-2013-04-01.paginators.json @@ -0,0 +1,33 @@ +{ + "pagination": { + "ListHealthChecks": { + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "HealthChecks" + }, + "ListHostedZones": { + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "HostedZones" + }, + "ListResourceRecordSets": { + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "ResourceRecordSets", + "input_token": [ + "StartRecordName", + "StartRecordType", + "StartRecordIdentifier" + ], + "output_token": [ + "NextRecordName", + "NextRecordType", + "NextRecordIdentifier" + ] + } + } +} diff --git a/apis/route53domains-2014-05-15.api.json b/apis/route53domains-2014-05-15.api.json new file mode 100644 index 0000000000..c1eee356a6 --- /dev/null +++ b/apis/route53domains-2014-05-15.api.json @@ -0,0 +1,512 @@ +{ + "metadata": { + "apiVersion": "2014-05-15", + "endpointPrefix": "route53domains", + "jsonVersion": "1.1", + "serviceFullName": "Amazon Route 53 Domains", + "signatureVersion": "v4", + "targetPrefix": "Route53Domains_v20140515", + "protocol": "json" + }, + "operations": { + "CheckDomainAvailability": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "IdnLangCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Availability" + ], + "members": { + "Availability": {} + } + } + }, + "DisableDomainTransferLock": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "EnableDomainTransferLock": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "GetDomainDetail": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "DomainName", + "Nameservers", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members": { + "DomainName": {}, + "Nameservers": { + "shape": "Sd" + }, + "AutoRenew": { + "type": "boolean" + }, + "AdminContact": { + "shape": "Sj" + }, + "RegistrantContact": { + "shape": "Sj" + }, + "TechContact": { + "shape": "Sj" + }, + "AdminPrivacy": { + "type": "boolean" + }, + "RegistrantPrivacy": { + "type": "boolean" + }, + "TechPrivacy": { + "type": "boolean" + }, + "RegistrarName": {}, + "WhoIsServer": {}, + "RegistrarUrl": {}, + "AbuseContactEmail": {}, + "AbuseContactPhone": {}, + "RegistryDomainId": {}, + "CreationDate": { + "type": "timestamp" + }, + "UpdatedDate": { + "type": "timestamp" + }, + "ExpirationDate": { + "type": "timestamp" + }, + "Reseller": {}, + "DnsSec": {}, + "StatusList": { + "type": "list", + "member": {} + } + } + } + }, + "GetOperationDetail": { + "input": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + }, + "output": { + "type": "structure", + "members": { + "OperationId": {}, + "Status": {}, + "Message": {}, + "DomainName": {}, + "Type": {}, + "SubmittedDate": { + "type": "timestamp" + } + } + } + }, + "ListDomains": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Domains" + ], + "members": { + "Domains": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AutoRenew": { + "type": "boolean" + }, + "TransferLock": { + "type": "boolean" + }, + "Expiry": { + "type": "timestamp" + } + } + } + }, + "NextPageMarker": {} + } + } + }, + "ListOperations": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "MaxItems": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Operations" + ], + "members": { + "Operations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "OperationId", + "Status", + "Type", + "SubmittedDate" + ], + "members": { + "OperationId": {}, + "Status": {}, + "Type": {}, + "SubmittedDate": { + "type": "timestamp" + } + } + } + }, + "NextPageMarker": {} + } + } + }, + "RegisterDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "DurationInYears", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members": { + "DomainName": {}, + "IdnLangCode": {}, + "DurationInYears": { + "type": "integer" + }, + "AutoRenew": { + "type": "boolean" + }, + "AdminContact": { + "shape": "Sj" + }, + "RegistrantContact": { + "shape": "Sj" + }, + "TechContact": { + "shape": "Sj" + }, + "PrivacyProtectAdminContact": { + "type": "boolean" + }, + "PrivacyProtectRegistrantContact": { + "type": "boolean" + }, + "PrivacyProtectTechContact": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "RetrieveDomainAuthCode": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "AuthCode" + ], + "members": { + "AuthCode": { + "shape": "S1q" + } + } + } + }, + "TransferDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "DurationInYears", + "Nameservers", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members": { + "DomainName": {}, + "IdnLangCode": {}, + "DurationInYears": { + "type": "integer" + }, + "Nameservers": { + "shape": "Sd" + }, + "AuthCode": { + "shape": "S1q" + }, + "AutoRenew": { + "type": "boolean" + }, + "AdminContact": { + "shape": "Sj" + }, + "RegistrantContact": { + "shape": "Sj" + }, + "TechContact": { + "shape": "Sj" + }, + "PrivacyProtectAdminContact": { + "type": "boolean" + }, + "PrivacyProtectRegistrantContact": { + "type": "boolean" + }, + "PrivacyProtectTechContact": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "UpdateDomainContact": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AdminContact": { + "shape": "Sj" + }, + "RegistrantContact": { + "shape": "Sj" + }, + "TechContact": { + "shape": "Sj" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "UpdateDomainContactPrivacy": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {}, + "AdminPrivacy": { + "type": "boolean" + }, + "RegistrantPrivacy": { + "type": "boolean" + }, + "TechPrivacy": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + }, + "UpdateDomainNameservers": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Nameservers" + ], + "members": { + "DomainName": {}, + "Nameservers": { + "shape": "Sd" + } + } + }, + "output": { + "type": "structure", + "required": [ + "OperationId" + ], + "members": { + "OperationId": {} + } + } + } + }, + "shapes": { + "Sd": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "GlueIps": { + "type": "list", + "member": {} + } + } + } + }, + "Sj": { + "type": "structure", + "members": { + "FirstName": {}, + "LastName": {}, + "ContactType": {}, + "OrganizationName": {}, + "AddressLine1": {}, + "AddressLine2": {}, + "City": {}, + "State": {}, + "CountryCode": {}, + "ZipCode": {}, + "PhoneNumber": {}, + "Email": {}, + "Fax": {}, + "ExtraParams": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {} + } + } + } + }, + "sensitive": true + }, + "S1q": { + "type": "string", + "sensitive": true + } + } +} \ No newline at end of file diff --git a/apis/route53domains-2014-05-15.full.json b/apis/route53domains-2014-05-15.full.json new file mode 100644 index 0000000000..c39c9a9ba6 --- /dev/null +++ b/apis/route53domains-2014-05-15.full.json @@ -0,0 +1,1622 @@ +{ + "metadata":{ + "apiVersion":"2014-05-15", + "endpointPrefix":"route53domains", + "jsonVersion":"1.1", + "serviceFullName":"Amazon Route 53 Domains", + "signatureVersion":"v4", + "targetPrefix":"Route53Domains_v20140515", + "protocol":"json" + }, + "operations":{ + "CheckDomainAvailability":{ + "name":"CheckDomainAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CheckDomainAvailabilityRequest", + "documentation":"

The CheckDomainAvailability request contains the following elements.

" + }, + "output":{ + "shape":"CheckDomainAvailabilityResponse", + "documentation":"

The CheckDomainAvailability response includes the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + { + "shape":"UnsupportedTLD", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Amazon Route 53 does not support this top-level domain.

" + } + ], + "documentation":"

This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

" + }, + "DisableDomainTransferLock":{ + "name":"DisableDomainTransferLock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DisableDomainTransferLockRequest", + "documentation":"

The DisableDomainTransferLock request includes the following element.

" + }, + "output":{ + "shape":"DisableDomainTransferLockResponse", + "documentation":"

The DisableDomainTransferLock response includes the following element.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + { + "shape":"DuplicateRequest", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request is already in progress for the domain.

" + }, + { + "shape":"TLDRulesViolation", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The top-level domain does not support this operation.

" + }, + { + "shape":"OperationLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

" + } + ], + "documentation":"

This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" + }, + "EnableDomainTransferLock":{ + "name":"EnableDomainTransferLock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"EnableDomainTransferLockRequest", + "documentation":"

The EnableDomainTransferLock request includes the following element.

" + }, + "output":{ + "shape":"EnableDomainTransferLockResponse", + "documentation":"

The EnableDomainTransferLock response includes the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + { + "shape":"DuplicateRequest", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request is already in progress for the domain.

" + }, + { + "shape":"TLDRulesViolation", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The top-level domain does not support this operation.

" + }, + { + "shape":"OperationLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

" + } + ], + "documentation":"

This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" + }, + "GetDomainDetail":{ + "name":"GetDomainDetail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetDomainDetailRequest", + "documentation":"

The GetDomainDetail request includes the following element.

" + }, + "output":{ + "shape":"GetDomainDetailResponse", + "documentation":"

The GetDomainDetail response includes the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + } + ], + "documentation":"

This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.

" + }, + "GetOperationDetail":{ + "name":"GetOperationDetail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetOperationDetailRequest", + "documentation":"

The GetOperationDetail request includes the following element.

" + }, + "output":{ + "shape":"GetOperationDetailResponse", + "documentation":"

The GetOperationDetail response includes the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + } + ], + "documentation":"

This operation returns the current status of an operation that is not completed.

" + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListDomainsRequest", + "documentation":"

The ListDomains request includes the following elements.

" + }, + "output":{ + "shape":"ListDomainsResponse", + "documentation":"

The ListDomains response includes the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + } + ], + "documentation":"

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

" + }, + "ListOperations":{ + "name":"ListOperations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListOperationsRequest", + "documentation":"

The ListOperations request includes the following elements.

" + }, + "output":{ + "shape":"ListOperationsResponse", + "documentation":"

The ListOperations response includes the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + } + ], + "documentation":"

This operation returns the operation IDs of operations that are not yet complete.

" + }, + "RegisterDomain":{ + "name":"RegisterDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RegisterDomainRequest", + "documentation":"

The RegisterDomain request includes the following elements.

" + }, + "output":{ + "shape":"RegisterDomainResponse", + "documentation":"

The RegisterDomain response includes the following element.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + { + "shape":"UnsupportedTLD", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Amazon Route 53 does not support this top-level domain.

" + }, + { + "shape":"DuplicateRequest", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request is already in progress for the domain.

" + }, + { + "shape":"TLDRulesViolation", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The top-level domain does not support this operation.

" + }, + { + "shape":"DomainLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of domains has exceeded the allowed threshold for the account.

" + }, + { + "shape":"OperationLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

" + } + ], + "documentation":"

This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.

When you register a domain, Amazon Route 53 does the following:

" + }, + "RetrieveDomainAuthCode":{ + "name":"RetrieveDomainAuthCode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RetrieveDomainAuthCodeRequest", + "documentation":"

The RetrieveDomainAuthCode request includes the following element.

" + }, + "output":{ + "shape":"RetrieveDomainAuthCodeResponse", + "documentation":"

The RetrieveDomainAuthCode response includes the following element.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + } + ], + "documentation":"

This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

" + }, + "TransferDomain":{ + "name":"TransferDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"TransferDomainRequest", + "documentation":"

The TransferDomain request includes the following elements.

" + }, + "output":{ + "shape":"TransferDomainResponse", + "documentation":"

The TranserDomain response includes the following element.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + { + "shape":"UnsupportedTLD", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Amazon Route 53 does not support this top-level domain.

" + }, + { + "shape":"DuplicateRequest", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request is already in progress for the domain.

" + }, + { + "shape":"TLDRulesViolation", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The top-level domain does not support this operation.

" + }, + { + "shape":"DomainLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of domains has exceeded the allowed threshold for the account.

" + }, + { + "shape":"OperationLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

" + } + ], + "documentation":"

This operation transfers a domain from another registrar to Amazon Route 53. Domains are registered by the AWS registrar, Gandi upon transfer.

To transfer a domain, you need to meet all the domain transfer criteria, including the following:

We recommend you use the Amazon Route 53 as the DNS service for your domain. You can create a hosted zone in Amazon Route 53 for your current domain before transferring your domain.

Note that upon transfer, the domain duration is extended for a year if not otherwise specified. Autorenew is enabled by default.

If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Transferring domains charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.

" + }, + "UpdateDomainContact":{ + "name":"UpdateDomainContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateDomainContactRequest", + "documentation":"

The UpdateDomainContact request includes the following elements.

" + }, + "output":{ + "shape":"UpdateDomainContactResponse", + "documentation":"

The UpdateDomainContact response includes the following element.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + { + "shape":"DuplicateRequest", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request is already in progress for the domain.

" + }, + { + "shape":"TLDRulesViolation", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The top-level domain does not support this operation.

" + }, + { + "shape":"OperationLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

" + } + ], + "documentation":"

This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.

If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" + }, + "UpdateDomainContactPrivacy":{ + "name":"UpdateDomainContactPrivacy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateDomainContactPrivacyRequest", + "documentation":"

The UpdateDomainContactPrivacy request includes the following elements.

" + }, + "output":{ + "shape":"UpdateDomainContactPrivacyResponse", + "documentation":"

The UpdateDomainContactPrivacy response includes the following element.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + { + "shape":"DuplicateRequest", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request is already in progress for the domain.

" + }, + { + "shape":"TLDRulesViolation", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The top-level domain does not support this operation.

" + }, + { + "shape":"OperationLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

" + } + ], + "documentation":"

This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.

This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" + }, + "UpdateDomainNameservers":{ + "name":"UpdateDomainNameservers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateDomainNameserversRequest", + "documentation":"

The UpdateDomainNameserver request includes the following elements.

" + }, + "output":{ + "shape":"UpdateDomainNameserversResponse", + "documentation":"

The UpdateDomainNameservers response includes the following element.

" + }, + "errors":[ + { + "shape":"InvalidInput", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + { + "shape":"DuplicateRequest", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request is already in progress for the domain.

" + }, + { + "shape":"TLDRulesViolation", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The top-level domain does not support this operation.

" + }, + { + "shape":"OperationLimitExceeded", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

" + } + ], + "documentation":"

This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" + } + }, + "shapes":{ + "AddressLine":{ + "type":"string", + "max":255 + }, + "Boolean":{"type":"boolean"}, + "CheckDomainAvailabilityRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + }, + "IdnLangCode":{ + "shape":"LangCode", + "documentation":"

Reserved for future use.

" + } + }, + "documentation":"

The CheckDomainAvailability request contains the following elements.

" + }, + "CheckDomainAvailabilityResponse":{ + "type":"structure", + "required":["Availability"], + "members":{ + "Availability":{ + "shape":"DomainAvailability", + "documentation":"

Whether the domain name is available for registering.

Type: String

Valid values:

" + } + }, + "documentation":"

The CheckDomainAvailability response includes the following elements.

" + }, + "City":{ + "type":"string", + "max":255 + }, + "ContactDetail":{ + "type":"structure", + "members":{ + "FirstName":{ + "shape":"ContactName", + "documentation":"

First name of contact.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" + }, + "LastName":{ + "shape":"ContactName", + "documentation":"

Last name of contact.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" + }, + "ContactType":{ + "shape":"ContactType", + "documentation":"

Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

Type: String

Default: None

Constraints: Maximum 255 characters.

Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" + }, + "OrganizationName":{ + "shape":"ContactName", + "documentation":"

Name of the organization for contact types other than PERSON.

Type: String

Default: None

Constraints: Maximum 255 characters. Contact type must not be PERSON.

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" + }, + "AddressLine1":{ + "shape":"AddressLine", + "documentation":"

First line of the contact's address.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" + }, + "AddressLine2":{ + "shape":"AddressLine", + "documentation":"

Second line of contact's address, if any.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" + }, + "City":{ + "shape":"City", + "documentation":"

The city of the contact's address.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" + }, + "State":{ + "shape":"State", + "documentation":"

The state or province of the contact's city.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" + }, + "CountryCode":{ + "shape":"CountryCode", + "documentation":"

Code for the country of the contact's address.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" + }, + "ZipCode":{ + "shape":"ZipCode", + "documentation":"

The zip or postal code of the contact's address.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" + }, + "PhoneNumber":{ + "shape":"ContactNumber", + "documentation":"

The phone number of the contact.

Type: String

Default: None

Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code>]\". For example, a US phone number might appear as \"+1.1234567890\".

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" + }, + "Email":{ + "shape":"Email", + "documentation":"

Email address of the contact.

Type: String

Default: None

Constraints: Maximum 254 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" + }, + "Fax":{ + "shape":"ContactNumber", + "documentation":"

Fax number of the contact.

Type: String

Default: None

Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". For example, a US phone number might appear as \"+1.1234567890\".

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" + }, + "ExtraParams":{ + "shape":"ExtraParamList", + "documentation":"

A list of name-value pairs for parameters required by certain top-level domains.

Type: Complex

Default: None

Parents: RegistrantContact, AdminContact, TechContact

Children: Name, Value

Required: No

" + } + }, + "sensitive":true, + "documentation":"

ContactDetail includes the following elements.

" + }, + "ContactName":{ + "type":"string", + "max":255 + }, + "ContactNumber":{ + "type":"string", + "max":30 + }, + "ContactType":{ + "type":"string", + "enum":[ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ] + }, + "CountryCode":{ + "type":"string", + "enum":[ + "AD", + "AE", + "AF", + "AG", + "AI", + "AL", + "AM", + "AN", + "AO", + "AQ", + "AR", + "AS", + "AT", + "AU", + "AW", + "AZ", + "BA", + "BB", + "BD", + "BE", + "BF", + "BG", + "BH", + "BI", + "BJ", + "BL", + "BM", + "BN", + "BO", + "BR", + "BS", + "BT", + "BW", + "BY", + "BZ", + "CA", + "CC", + "CD", + "CF", + "CG", + "CH", + "CI", + "CK", + "CL", + "CM", + "CN", + "CO", + "CR", + "CU", + "CV", + "CX", + "CY", + "CZ", + "DE", + "DJ", + "DK", + "DM", + "DO", + "DZ", + "EC", + "EE", + "EG", + "ER", + "ES", + "ET", + "FI", + "FJ", + "FK", + "FM", + "FO", + "FR", + "GA", + "GB", + "GD", + "GE", + "GH", + "GI", + "GL", + "GM", + "GN", + "GQ", + "GR", + "GT", + "GU", + "GW", + "GY", + "HK", + "HN", + "HR", + "HT", + "HU", + "ID", + "IE", + "IL", + "IM", + "IN", + "IQ", + "IR", + "IS", + "IT", + "JM", + "JO", + "JP", + "KE", + "KG", + "KH", + "KI", + "KM", + "KN", + "KP", + "KR", + "KW", + "KY", + "KZ", + "LA", + "LB", + "LC", + "LI", + "LK", + "LR", + "LS", + "LT", + "LU", + "LV", + "LY", + "MA", + "MC", + "MD", + "ME", + "MF", + "MG", + "MH", + "MK", + "ML", + "MM", + "MN", + "MO", + "MP", + "MR", + "MS", + "MT", + "MU", + "MV", + "MW", + "MX", + "MY", + "MZ", + "NA", + "NC", + "NE", + "NG", + "NI", + "NL", + "NO", + "NP", + "NR", + "NU", + "NZ", + "OM", + "PA", + "PE", + "PF", + "PG", + "PH", + "PK", + "PL", + "PM", + "PN", + "PR", + "PT", + "PW", + "PY", + "QA", + "RO", + "RS", + "RU", + "RW", + "SA", + "SB", + "SC", + "SD", + "SE", + "SG", + "SH", + "SI", + "SK", + "SL", + "SM", + "SN", + "SO", + "SR", + "ST", + "SV", + "SY", + "SZ", + "TC", + "TD", + "TG", + "TH", + "TJ", + "TK", + "TL", + "TM", + "TN", + "TO", + "TR", + "TT", + "TV", + "TW", + "TZ", + "UA", + "UG", + "US", + "UY", + "UZ", + "VA", + "VC", + "VE", + "VG", + "VI", + "VN", + "VU", + "WF", + "WS", + "YE", + "YT", + "ZA", + "ZM", + "ZW" + ] + }, + "DNSSec":{"type":"string"}, + "DisableDomainTransferLockRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + } + }, + "documentation":"

The DisableDomainTransferLock request includes the following element.

" + }, + "DisableDomainTransferLockResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" + } + }, + "documentation":"

The DisableDomainTransferLock response includes the following element.

" + }, + "DomainAuthCode":{ + "type":"string", + "max":1024, + "sensitive":true + }, + "DomainAvailability":{ + "type":"string", + "enum":[ + "AVAILABLE", + "AVAILABLE_RESERVED", + "AVAILABLE_PREORDER", + "UNAVAILABLE", + "UNAVAILABLE_PREMIUM", + "UNAVAILABLE_RESTRICTED", + "RESERVED" + ] + }, + "DomainLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of domains has exceeded the allowed threshold for the account.

" + }, + "DomainName":{ + "type":"string", + "max":255, + "pattern":"[a-zA-Z0-9_\\-.]*" + }, + "DomainStatus":{"type":"string"}, + "DomainStatusList":{ + "type":"list", + "member":{"shape":"DomainStatus"} + }, + "DomainSummary":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

" + }, + "AutoRenew":{ + "shape":"Boolean", + "documentation":"

Indicates whether the domain is automatically renewed upon expiration.

Type: Boolean

Valid values: True | False

" + }, + "TransferLock":{ + "shape":"Boolean", + "documentation":"

Indicates whether a domain is locked from unauthorized transfer to another party.

Type: Boolean

Valid values: True | False

" + }, + "Expiry":{ + "shape":"Timestamp", + "documentation":"

Expiration date of the domain in Coordinated Universal Time (UTC).

Type: Long

" + } + } + }, + "DomainSummaryList":{ + "type":"list", + "member":{"shape":"DomainSummary"} + }, + "DuplicateRequest":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request is already in progress for the domain.

" + }, + "DurationInYears":{ + "type":"integer", + "min":1, + "max":10 + }, + "Email":{ + "type":"string", + "max":254 + }, + "EnableDomainTransferLockRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + } + }, + "documentation":"

The EnableDomainTransferLock request includes the following element.

" + }, + "EnableDomainTransferLockResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" + } + }, + "documentation":"

The EnableDomainTransferLock response includes the following elements.

" + }, + "ErrorMessage":{"type":"string"}, + "ExtraParam":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"ExtraParamName", + "documentation":"

Name of the additional parameter required by the top-level domain.

Type: String

Default: None

Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

Parent: ExtraParams

Required: Yes

" + }, + "Value":{ + "shape":"ExtraParamValue", + "documentation":"

Values corresponding to the additional parameter names required by some top-level domains.

Type: String

Default: None

Constraints: Maximum 2048 characters.

Parent: ExtraParams

Required: Yes

" + } + }, + "documentation":"

ExtraParam includes the following elements.

" + }, + "ExtraParamList":{ + "type":"list", + "member":{"shape":"ExtraParam"} + }, + "ExtraParamName":{ + "type":"string", + "enum":[ + "DUNS_NUMBER", + "BRAND_NUMBER", + "BIRTH_DEPARTMENT", + "BIRTH_DATE_IN_YYYY_MM_DD", + "BIRTH_COUNTRY", + "BIRTH_CITY", + "DOCUMENT_NUMBER", + "AU_ID_NUMBER", + "AU_ID_TYPE", + "CA_LEGAL_TYPE", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ] + }, + "ExtraParamValue":{ + "type":"string", + "max":2048 + }, + "GetDomainDetailRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + } + }, + "documentation":"

The GetDomainDetail request includes the following element.

" + }, + "GetDomainDetailResponse":{ + "type":"structure", + "required":[ + "DomainName", + "Nameservers", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

" + }, + "Nameservers":{ + "shape":"NameserverList", + "documentation":"

The name of the domain.

Type: String

" + }, + "AutoRenew":{ + "shape":"Boolean", + "documentation":"

Specifies whether the domain registration is set to renew automatically.

Type: Boolean

" + }, + "AdminContact":{ + "shape":"ContactDetail", + "documentation":"

Provides details about the domain administrative contact.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

" + }, + "RegistrantContact":{ + "shape":"ContactDetail", + "documentation":"

Provides details about the domain registrant.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

" + }, + "TechContact":{ + "shape":"ContactDetail", + "documentation":"

Provides details about the domain technical contact.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

" + }, + "AdminPrivacy":{ + "shape":"Boolean", + "documentation":"

Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

" + }, + "RegistrantPrivacy":{ + "shape":"Boolean", + "documentation":"

Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

" + }, + "TechPrivacy":{ + "shape":"Boolean", + "documentation":"

Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

" + }, + "RegistrarName":{ + "shape":"RegistrarName", + "documentation":"

Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi. The value is \"GANDI SAS\".

Type: String

" + }, + "WhoIsServer":{ + "shape":"RegistrarWhoIsServer", + "documentation":"

The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

Type: String

" + }, + "RegistrarUrl":{ + "shape":"RegistrarUrl", + "documentation":"

Web address of the registrar.

Type: String

" + }, + "AbuseContactEmail":{ + "shape":"Email", + "documentation":"

Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

Type: String

" + }, + "AbuseContactPhone":{ + "shape":"ContactNumber", + "documentation":"

Phone number for reporting abuse.

Type: String

" + }, + "RegistryDomainId":{ + "shape":"RegistryDomainId", + "documentation":"

Reserved for future use.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.

" + }, + "UpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.

" + }, + "ExpirationDate":{ + "shape":"Timestamp", + "documentation":"

The date when the registration for the domain is set to expire. The date format is Unix time.

" + }, + "Reseller":{ + "shape":"Reseller", + "documentation":"

Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have \"Amazon\" as the reseller.

Type: String

" + }, + "DnsSec":{ + "shape":"DNSSec", + "documentation":"

Reserved for future use.

" + }, + "StatusList":{ + "shape":"DomainStatusList", + "documentation":"

An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.

For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)

Type: Array of String

" + } + }, + "documentation":"

The GetDomainDetail response includes the following elements.

" + }, + "GetOperationDetailRequest":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.

Type: String

Default: None

Required: Yes

" + } + }, + "documentation":"

The GetOperationDetail request includes the following element.

" + }, + "GetOperationDetailResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

The identifier for the operation.

Type: String

" + }, + "Status":{ + "shape":"OperationStatus", + "documentation":"

The current status of the requested operation in the system.

Type: String

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

Detailed information on the status including possible errors.

Type: String

" + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

" + }, + "Type":{ + "shape":"OperationType", + "documentation":"

The type of operation that was requested.

Type: String

" + }, + "SubmittedDate":{ + "shape":"Timestamp", + "documentation":"

The date when the request was submitted.

" + } + }, + "documentation":"

The GetOperationDetail response includes the following elements.

" + }, + "GlueIp":{ + "type":"string", + "max":45 + }, + "GlueIpList":{ + "type":"list", + "member":{"shape":"GlueIp"} + }, + "HostName":{ + "type":"string", + "max":255, + "pattern":"[a-zA-Z0-9_\\-.]*" + }, + "InvalidInput":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

" + }, + "LangCode":{ + "type":"string", + "max":3 + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "documentation":"

For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Type: String

Default: None

Constraints: The marker must match the value specified in the previous request.

Required: No

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

Number of domains to be returned.

Type: Integer

Default: 20

Constraints: A numeral between 1 and 100.

Required: No

" + } + }, + "documentation":"

The ListDomains request includes the following elements.

" + }, + "ListDomainsResponse":{ + "type":"structure", + "required":["Domains"], + "members":{ + "Domains":{ + "shape":"DomainSummaryList", + "documentation":"

A summary of domains.

Type: Complex type containing a list of domain summaries.

Children: AutoRenew, DomainName, Expiry, TransferLock

" + }, + "NextPageMarker":{ + "shape":"PageMarker", + "documentation":"

If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

Type: String

Parent: Operations

" + } + }, + "documentation":"

The ListDomains response includes the following elements.

" + }, + "ListOperationsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "documentation":"

For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Type: String

Default: None

Required: No

" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

Number of domains to be returned.

Type: Integer

Default: 20

Constraints: A value between 1 and 100.

Required: No

" + } + }, + "documentation":"

The ListOperations request includes the following elements.

" + }, + "ListOperationsResponse":{ + "type":"structure", + "required":["Operations"], + "members":{ + "Operations":{ + "shape":"OperationSummaryList", + "documentation":"

Lists summaries of the operations.

Type: Complex type containing a list of operation summaries

Children: OperationId, Status, SubmittedDate, Type

" + }, + "NextPageMarker":{ + "shape":"PageMarker", + "documentation":"

If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

Type: String

Parent: Operations

" + } + }, + "documentation":"

The ListOperations response includes the following elements.

" + }, + "Nameserver":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"HostName", + "documentation":"

The fully qualified host name of the name server.

Type: String

Constraint: Maximum 255 characterss

Parent: Nameservers

" + }, + "GlueIps":{ + "shape":"GlueIpList", + "documentation":"

Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.

Type: List of IP addresses.

Constraints: The list can contain only one IPv4 and one IPv6 address.

Parent: Nameservers

" + } + }, + "documentation":"

Nameserver includes the following elements.

" + }, + "NameserverList":{ + "type":"list", + "member":{"shape":"Nameserver"} + }, + "OperationId":{ + "type":"string", + "max":255 + }, + "OperationLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

" + }, + "OperationStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "ERROR", + "SUCCESSFUL", + "FAILED" + ] + }, + "OperationSummary":{ + "type":"structure", + "required":[ + "OperationId", + "Status", + "Type", + "SubmittedDate" + ], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

Identifier returned to track the requested action.

Type: String

" + }, + "Status":{ + "shape":"OperationStatus", + "documentation":"

The current status of the requested operation in the system.

Type: String

" + }, + "Type":{ + "shape":"OperationType", + "documentation":"

Type of the action requested.

Type: String

Valid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK

" + }, + "SubmittedDate":{ + "shape":"Timestamp", + "documentation":"

The date when the request was submitted.

" + } + }, + "documentation":"

OperationSummary includes the following elements.

" + }, + "OperationSummaryList":{ + "type":"list", + "member":{"shape":"OperationSummary"} + }, + "OperationType":{ + "type":"string", + "enum":[ + "REGISTER_DOMAIN", + "DELETE_DOMAIN", + "TRANSFER_IN_DOMAIN", + "UPDATE_DOMAIN_CONTACT", + "UPDATE_NAMESERVER", + "CHANGE_PRIVACY_PROTECTION", + "DOMAIN_LOCK" + ] + }, + "PageMarker":{ + "type":"string", + "max":4096 + }, + "PageMaxItems":{ + "type":"integer", + "max":100 + }, + "RegisterDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "DurationInYears", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + }, + "IdnLangCode":{ + "shape":"LangCode", + "documentation":"

Reserved for future use.

" + }, + "DurationInYears":{ + "shape":"DurationInYears", + "documentation":"

The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

Type: Integer

Default: 1

Valid values: Integer from 1 to 10

Required: Yes

" + }, + "AutoRenew":{ + "shape":"Boolean", + "documentation":"

Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

Type: Boolean

Valid values: true | false

Default: true

Required: No

" + }, + "AdminContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + }, + "RegistrantContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + }, + "TechContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + }, + "PrivacyProtectAdminContact":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" + }, + "PrivacyProtectRegistrantContact":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" + }, + "PrivacyProtectTechContact":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" + } + }, + "documentation":"

The RegisterDomain request includes the following elements.

" + }, + "RegisterDomainResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" + } + }, + "documentation":"

The RegisterDomain response includes the following element.

" + }, + "RegistrarName":{"type":"string"}, + "RegistrarUrl":{"type":"string"}, + "RegistrarWhoIsServer":{"type":"string"}, + "RegistryDomainId":{"type":"string"}, + "Reseller":{"type":"string"}, + "RetrieveDomainAuthCodeRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + } + }, + "documentation":"

The RetrieveDomainAuthCode request includes the following element.

" + }, + "RetrieveDomainAuthCodeResponse":{ + "type":"structure", + "required":["AuthCode"], + "members":{ + "AuthCode":{ + "shape":"DomainAuthCode", + "documentation":"

The authorization code for the domain.

Type: String

" + } + }, + "documentation":"

The RetrieveDomainAuthCode response includes the following element.

" + }, + "State":{ + "type":"string", + "max":255 + }, + "TLDRulesViolation":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The top-level domain does not support this operation.

" + }, + "Timestamp":{"type":"timestamp"}, + "TransferDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "DurationInYears", + "Nameservers", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + }, + "IdnLangCode":{ + "shape":"LangCode", + "documentation":"

Reserved for future use.

" + }, + "DurationInYears":{ + "shape":"DurationInYears", + "documentation":"

The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

Type: Integer

Default: 1

Valid values: Integer from 1 to 10

Required: Yes

" + }, + "Nameservers":{ + "shape":"NameserverList", + "documentation":"

Contains details for the host and glue IP addresses.

Type: Complex

Children: GlueIps, Name

" + }, + "AuthCode":{ + "shape":"DomainAuthCode", + "documentation":"

The authorization code for the domain. You get this value from the current registrar.

Type: String

Required: Yes

" + }, + "AutoRenew":{ + "shape":"Boolean", + "documentation":"

Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

Type: Boolean

Valid values: true | false

Default: true

Required: No

" + }, + "AdminContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + }, + "RegistrantContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + }, + "TechContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + }, + "PrivacyProtectAdminContact":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" + }, + "PrivacyProtectRegistrantContact":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" + }, + "PrivacyProtectTechContact":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" + } + }, + "documentation":"

The TransferDomain request includes the following elements.

" + }, + "TransferDomainResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" + } + }, + "documentation":"

The TranserDomain response includes the following element.

" + }, + "UnsupportedTLD":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

Amazon Route 53 does not support this top-level domain.

" + }, + "UpdateDomainContactPrivacyRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + }, + "AdminPrivacy":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: true | false

Required: No

" + }, + "RegistrantPrivacy":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: true | false

Required: No

" + }, + "TechPrivacy":{ + "shape":"Boolean", + "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: true | false

Required: No

" + } + }, + "documentation":"

The UpdateDomainContactPrivacy request includes the following elements.

" + }, + "UpdateDomainContactPrivacyResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" + } + }, + "documentation":"

The UpdateDomainContactPrivacy response includes the following element.

" + }, + "UpdateDomainContactRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + }, + "AdminContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + }, + "RegistrantContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + }, + "TechContact":{ + "shape":"ContactDetail", + "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" + } + }, + "documentation":"

The UpdateDomainContact request includes the following elements.

" + }, + "UpdateDomainContactResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" + } + }, + "documentation":"

The UpdateDomainContact response includes the following element.

" + }, + "UpdateDomainNameserversRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Nameservers" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" + }, + "Nameservers":{ + "shape":"NameserverList", + "documentation":"

A list of new name servers for the domain.

Type: Complex

Children: Name, GlueIps

Required: Yes

" + } + }, + "documentation":"

The UpdateDomainNameserver request includes the following elements.

" + }, + "UpdateDomainNameserversResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" + } + }, + "documentation":"

The UpdateDomainNameservers response includes the following element.

" + }, + "ZipCode":{ + "type":"string", + "max":255 + } + } +} diff --git a/apis/s3-2006-03-01.api.json b/apis/s3-2006-03-01.api.json new file mode 100644 index 0000000000..decf39552d --- /dev/null +++ b/apis/s3-2006-03-01.api.json @@ -0,0 +1,2905 @@ +{ + "metadata": { + "apiVersion": "2006-03-01", + "checksumFormat": "md5", + "endpointPrefix": "s3", + "globalEndpoint": "s3.amazonaws.com", + "serviceAbbreviation": "Amazon S3", + "serviceFullName": "Amazon Simple Storage Service", + "signatureVersion": "s3", + "timestampFormat": "rfc822", + "protocol": "rest-xml" + }, + "operations": { + "AbortMultipartUpload": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "UploadId" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + } + } + } + }, + "CompleteMultipartUpload": { + "http": { + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "UploadId" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "MultipartUpload": { + "locationName": "CompleteMultipartUpload", + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "type": "structure", + "members": { + "Parts": { + "locationName": "Part", + "type": "list", + "member": { + "type": "structure", + "members": { + "ETag": {}, + "PartNumber": { + "type": "integer" + } + } + }, + "flattened": true + } + } + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + } + }, + "payload": "MultipartUpload" + }, + "output": { + "type": "structure", + "members": { + "Location": {}, + "Bucket": {}, + "Key": {}, + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration", + "type": "timestamp" + }, + "ETag": {}, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + } + } + } + }, + "CopyObject": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "CopySource", + "Key" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "CopySource": { + "location": "header", + "locationName": "x-amz-copy-source" + }, + "CopySourceIfMatch": { + "location": "header", + "locationName": "x-amz-copy-source-if-match" + }, + "CopySourceIfModifiedSince": { + "location": "header", + "locationName": "x-amz-copy-source-if-modified-since", + "type": "timestamp" + }, + "CopySourceIfNoneMatch": { + "location": "header", + "locationName": "x-amz-copy-source-if-none-match" + }, + "CopySourceIfUnmodifiedSince": { + "location": "header", + "locationName": "x-amz-copy-source-if-unmodified-since", + "type": "timestamp" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Metadata": { + "shape": "Sx", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "MetadataDirective": { + "location": "header", + "locationName": "x-amz-metadata-directive" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "CopySourceSSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm" + }, + "CopySourceSSECustomerKey": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-key" + }, + "CopySourceSSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + } + } + }, + "output": { + "type": "structure", + "members": { + "CopyObjectResult": { + "type": "structure", + "members": { + "ETag": {}, + "LastModified": { + "type": "timestamp" + } + } + }, + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration", + "type": "timestamp" + }, + "CopySourceVersionId": { + "location": "header", + "locationName": "x-amz-copy-source-version-id" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "payload": "CopyObjectResult" + }, + "alias": "PutObjectCopy" + }, + "CreateBucket": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CreateBucketConfiguration": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "CreateBucketConfiguration", + "type": "structure", + "members": { + "LocationConstraint": {} + } + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWrite": { + "location": "header", + "locationName": "x-amz-grant-write" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + } + }, + "payload": "CreateBucketConfiguration" + }, + "output": { + "type": "structure", + "members": { + "Location": { + "location": "header", + "locationName": "Location" + } + } + }, + "alias": "PutBucket" + }, + "CreateMultipartUpload": { + "http": { + "requestUri": "/{Bucket}/{Key}?uploads" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Metadata": { + "shape": "Sx", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + } + }, + "output": { + "type": "structure", + "members": { + "Bucket": { + "locationName": "Bucket" + }, + "Key": {}, + "UploadId": {}, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + } + }, + "alias": "InitiateMultipartUpload" + }, + "DeleteBucket": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketCors": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?cors" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketLifecycle": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?lifecycle" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketPolicy": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?policy" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketTagging": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?tagging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteBucketWebsite": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}?website" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "DeleteObject": { + "http": { + "method": "DELETE", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "MFA": { + "location": "header", + "locationName": "x-amz-mfa" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeleteMarker": { + "location": "header", + "locationName": "x-amz-delete-marker", + "type": "boolean" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + } + } + } + }, + "DeleteObjects": { + "http": { + "requestUri": "/{Bucket}?delete" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Delete" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delete": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "Delete", + "type": "structure", + "required": [ + "Objects" + ], + "members": { + "Objects": { + "locationName": "Object", + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {}, + "VersionId": {} + } + }, + "flattened": true + }, + "Quiet": { + "type": "boolean" + } + } + }, + "MFA": { + "location": "header", + "locationName": "x-amz-mfa" + } + }, + "payload": "Delete" + }, + "output": { + "type": "structure", + "members": { + "Deleted": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "VersionId": {}, + "DeleteMarker": { + "type": "boolean" + }, + "DeleteMarkerVersionId": {} + } + }, + "flattened": true + }, + "Errors": { + "locationName": "Error", + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "VersionId": {}, + "Code": {}, + "Message": {} + } + }, + "flattened": true + } + } + }, + "alias": "DeleteMultipleObjects" + }, + "GetBucketAcl": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?acl" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Owner": { + "shape": "S2a" + }, + "Grants": { + "shape": "S2d", + "locationName": "AccessControlList" + } + } + } + }, + "GetBucketCors": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?cors" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "CORSRules": { + "shape": "S2m", + "locationName": "CORSRule" + } + } + } + }, + "GetBucketLifecycle": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?lifecycle" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Rules": { + "shape": "S2z", + "locationName": "Rule" + } + } + } + }, + "GetBucketLocation": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?location" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocationConstraint": {} + } + } + }, + "GetBucketLogging": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?logging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "LoggingEnabled": { + "shape": "S3e" + } + } + } + }, + "GetBucketNotification": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?notification" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "TopicConfiguration": { + "shape": "S3m" + } + } + } + }, + "GetBucketPolicy": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?policy" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {} + }, + "payload": "Policy" + } + }, + "GetBucketRequestPayment": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?requestPayment" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Payer": {} + } + } + }, + "GetBucketTagging": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?tagging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "required": [ + "TagSet" + ], + "members": { + "TagSet": { + "shape": "S3x" + } + } + } + }, + "GetBucketVersioning": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?versioning" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": {}, + "MFADelete": { + "locationName": "MfaDelete" + } + } + } + }, + "GetBucketWebsite": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?website" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + }, + "output": { + "type": "structure", + "members": { + "RedirectAllRequestsTo": { + "shape": "S46" + }, + "IndexDocument": { + "shape": "S49" + }, + "ErrorDocument": { + "shape": "S4b" + }, + "RoutingRules": { + "shape": "S4c" + } + } + } + }, + "GetObject": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + }, + "IfModifiedSince": { + "location": "header", + "locationName": "If-Modified-Since", + "type": "timestamp" + }, + "IfNoneMatch": { + "location": "header", + "locationName": "If-None-Match" + }, + "IfUnmodifiedSince": { + "location": "header", + "locationName": "If-Unmodified-Since", + "type": "timestamp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Range": { + "location": "header", + "locationName": "Range" + }, + "ResponseCacheControl": { + "location": "querystring", + "locationName": "response-cache-control" + }, + "ResponseContentDisposition": { + "location": "querystring", + "locationName": "response-content-disposition" + }, + "ResponseContentEncoding": { + "location": "querystring", + "locationName": "response-content-encoding" + }, + "ResponseContentLanguage": { + "location": "querystring", + "locationName": "response-content-language" + }, + "ResponseContentType": { + "location": "querystring", + "locationName": "response-content-type" + }, + "ResponseExpires": { + "location": "querystring", + "locationName": "response-expires", + "type": "timestamp" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + } + }, + "output": { + "type": "structure", + "members": { + "Body": { + "streaming": true, + "type": "blob" + }, + "DeleteMarker": { + "location": "header", + "locationName": "x-amz-delete-marker", + "type": "boolean" + }, + "AcceptRanges": { + "location": "header", + "locationName": "accept-ranges" + }, + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration", + "type": "timestamp" + }, + "Restore": { + "location": "header", + "locationName": "x-amz-restore" + }, + "LastModified": { + "location": "header", + "locationName": "Last-Modified", + "type": "timestamp" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "integer" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "MissingMeta": { + "location": "header", + "locationName": "x-amz-missing-meta", + "type": "integer" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "Metadata": { + "shape": "Sx", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "payload": "Body" + } + }, + "GetObjectAcl": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key}?acl" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Owner": { + "shape": "S2a" + }, + "Grants": { + "shape": "S2d", + "locationName": "AccessControlList" + } + } + } + }, + "GetObjectTorrent": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key}?torrent" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + } + } + }, + "output": { + "type": "structure", + "members": { + "Body": { + "streaming": true, + "type": "blob" + } + }, + "payload": "Body" + } + }, + "HeadBucket": { + "http": { + "method": "HEAD", + "requestUri": "/{Bucket}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + } + } + } + }, + "HeadObject": { + "http": { + "method": "HEAD", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "IfMatch": { + "location": "header", + "locationName": "If-Match" + }, + "IfModifiedSince": { + "location": "header", + "locationName": "If-Modified-Since", + "type": "timestamp" + }, + "IfNoneMatch": { + "location": "header", + "locationName": "If-None-Match" + }, + "IfUnmodifiedSince": { + "location": "header", + "locationName": "If-Unmodified-Since", + "type": "timestamp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Range": { + "location": "header", + "locationName": "Range" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeleteMarker": { + "location": "header", + "locationName": "x-amz-delete-marker", + "type": "boolean" + }, + "AcceptRanges": { + "location": "header", + "locationName": "accept-ranges" + }, + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration", + "type": "timestamp" + }, + "Restore": { + "location": "header", + "locationName": "x-amz-restore" + }, + "LastModified": { + "location": "header", + "locationName": "Last-Modified", + "type": "timestamp" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "integer" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "MissingMeta": { + "location": "header", + "locationName": "x-amz-missing-meta", + "type": "integer" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "Metadata": { + "shape": "Sx", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + } + } + }, + "ListBuckets": { + "http": { + "method": "GET" + }, + "output": { + "type": "structure", + "members": { + "Buckets": { + "type": "list", + "member": { + "locationName": "Bucket", + "type": "structure", + "members": { + "Name": {}, + "CreationDate": { + "type": "timestamp" + } + } + } + }, + "Owner": { + "shape": "S2a" + } + } + }, + "alias": "GetService" + }, + "ListMultipartUploads": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?uploads" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delimiter": { + "location": "querystring", + "locationName": "delimiter" + }, + "EncodingType": { + "location": "querystring", + "locationName": "encoding-type" + }, + "KeyMarker": { + "location": "querystring", + "locationName": "key-marker" + }, + "MaxUploads": { + "location": "querystring", + "locationName": "max-uploads", + "type": "integer" + }, + "Prefix": { + "location": "querystring", + "locationName": "prefix" + }, + "UploadIdMarker": { + "location": "querystring", + "locationName": "upload-id-marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "Bucket": {}, + "KeyMarker": {}, + "UploadIdMarker": {}, + "NextKeyMarker": {}, + "Prefix": {}, + "NextUploadIdMarker": {}, + "MaxUploads": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Uploads": { + "locationName": "Upload", + "type": "list", + "member": { + "type": "structure", + "members": { + "UploadId": {}, + "Key": {}, + "Initiated": { + "type": "timestamp" + }, + "StorageClass": {}, + "Owner": { + "shape": "S2a" + }, + "Initiator": { + "shape": "S5r" + } + } + }, + "flattened": true + }, + "CommonPrefixes": { + "shape": "S5s" + }, + "EncodingType": {} + } + } + }, + "ListObjectVersions": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}?versions" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delimiter": { + "location": "querystring", + "locationName": "delimiter" + }, + "EncodingType": { + "location": "querystring", + "locationName": "encoding-type" + }, + "KeyMarker": { + "location": "querystring", + "locationName": "key-marker" + }, + "MaxKeys": { + "location": "querystring", + "locationName": "max-keys", + "type": "integer" + }, + "Prefix": { + "location": "querystring", + "locationName": "prefix" + }, + "VersionIdMarker": { + "location": "querystring", + "locationName": "version-id-marker" + } + } + }, + "output": { + "type": "structure", + "members": { + "IsTruncated": { + "type": "boolean" + }, + "KeyMarker": {}, + "VersionIdMarker": {}, + "NextKeyMarker": {}, + "NextVersionIdMarker": {}, + "Versions": { + "locationName": "Version", + "type": "list", + "member": { + "type": "structure", + "members": { + "ETag": {}, + "Size": { + "type": "integer" + }, + "StorageClass": {}, + "Key": {}, + "VersionId": {}, + "IsLatest": { + "type": "boolean" + }, + "LastModified": { + "type": "timestamp" + }, + "Owner": { + "shape": "S2a" + } + } + }, + "flattened": true + }, + "DeleteMarkers": { + "locationName": "DeleteMarker", + "type": "list", + "member": { + "type": "structure", + "members": { + "Owner": { + "shape": "S2a" + }, + "Key": {}, + "VersionId": {}, + "IsLatest": { + "type": "boolean" + }, + "LastModified": { + "type": "timestamp" + } + } + }, + "flattened": true + }, + "Name": {}, + "Prefix": {}, + "MaxKeys": { + "type": "integer" + }, + "CommonPrefixes": { + "shape": "S5s" + }, + "EncodingType": {} + } + }, + "alias": "GetBucketObjectVersions" + }, + "ListObjects": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Delimiter": { + "location": "querystring", + "locationName": "delimiter" + }, + "EncodingType": { + "location": "querystring", + "locationName": "encoding-type" + }, + "Marker": { + "location": "querystring", + "locationName": "marker" + }, + "MaxKeys": { + "location": "querystring", + "locationName": "max-keys", + "type": "integer" + }, + "Prefix": { + "location": "querystring", + "locationName": "prefix" + } + } + }, + "output": { + "type": "structure", + "members": { + "IsTruncated": { + "type": "boolean" + }, + "Marker": {}, + "NextMarker": {}, + "Contents": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "LastModified": { + "type": "timestamp" + }, + "ETag": {}, + "Size": { + "type": "integer" + }, + "StorageClass": {}, + "Owner": { + "shape": "S2a" + } + } + }, + "flattened": true + }, + "Name": {}, + "Prefix": {}, + "MaxKeys": { + "type": "integer" + }, + "CommonPrefixes": { + "shape": "S5s" + }, + "EncodingType": {} + } + }, + "alias": "GetBucket" + }, + "ListParts": { + "http": { + "method": "GET", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "UploadId" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "MaxParts": { + "location": "querystring", + "locationName": "max-parts", + "type": "integer" + }, + "PartNumberMarker": { + "location": "querystring", + "locationName": "part-number-marker", + "type": "integer" + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Bucket": {}, + "Key": {}, + "UploadId": {}, + "PartNumberMarker": { + "type": "integer" + }, + "NextPartNumberMarker": { + "type": "integer" + }, + "MaxParts": { + "type": "integer" + }, + "IsTruncated": { + "type": "boolean" + }, + "Parts": { + "locationName": "Part", + "type": "list", + "member": { + "type": "structure", + "members": { + "PartNumber": { + "type": "integer" + }, + "LastModified": { + "type": "timestamp" + }, + "ETag": {}, + "Size": { + "type": "integer" + } + } + }, + "flattened": true + }, + "Initiator": { + "shape": "S5r" + }, + "Owner": { + "shape": "S2a" + }, + "StorageClass": {} + } + } + }, + "PutBucketAcl": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?acl" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "AccessControlPolicy": { + "shape": "S6l", + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "AccessControlPolicy" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWrite": { + "location": "header", + "locationName": "x-amz-grant-write" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + } + }, + "payload": "AccessControlPolicy" + } + }, + "PutBucketCors": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?cors" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CORSConfiguration": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "CORSConfiguration", + "type": "structure", + "members": { + "CORSRules": { + "shape": "S2m", + "locationName": "CORSRule" + } + } + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + } + }, + "payload": "CORSConfiguration" + } + }, + "PutBucketLifecycle": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?lifecycle" + }, + "input": { + "type": "structure", + "required": [ + "Bucket" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "LifecycleConfiguration": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "LifecycleConfiguration", + "type": "structure", + "required": [ + "Rules" + ], + "members": { + "Rules": { + "shape": "S2z", + "locationName": "Rule" + } + } + } + }, + "payload": "LifecycleConfiguration" + } + }, + "PutBucketLogging": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?logging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "BucketLoggingStatus" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "BucketLoggingStatus": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "BucketLoggingStatus", + "type": "structure", + "members": { + "LoggingEnabled": { + "shape": "S3e" + } + } + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + } + }, + "payload": "BucketLoggingStatus" + } + }, + "PutBucketNotification": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?notification" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "NotificationConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "NotificationConfiguration": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "NotificationConfiguration", + "type": "structure", + "required": [ + "TopicConfiguration" + ], + "members": { + "TopicConfiguration": { + "shape": "S3m" + } + } + } + }, + "payload": "NotificationConfiguration" + } + }, + "PutBucketPolicy": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?policy" + }, + "input": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "PutBucketPolicyRequest", + "type": "structure", + "required": [ + "Bucket", + "Policy" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "Policy": {} + }, + "payload": "Policy" + } + }, + "PutBucketRequestPayment": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?requestPayment" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "RequestPaymentConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "RequestPaymentConfiguration": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "RequestPaymentConfiguration", + "type": "structure", + "required": [ + "Payer" + ], + "members": { + "Payer": {} + } + } + }, + "payload": "RequestPaymentConfiguration" + } + }, + "PutBucketTagging": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?tagging" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Tagging" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "Tagging": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "Tagging", + "type": "structure", + "required": [ + "TagSet" + ], + "members": { + "TagSet": { + "shape": "S3x" + } + } + } + }, + "payload": "Tagging" + } + }, + "PutBucketVersioning": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?versioning" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "VersioningConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "MFA": { + "location": "header", + "locationName": "x-amz-mfa" + }, + "VersioningConfiguration": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "VersioningConfiguration", + "type": "structure", + "members": { + "MFADelete": { + "locationName": "MfaDelete" + }, + "Status": {} + } + } + }, + "payload": "VersioningConfiguration" + } + }, + "PutBucketWebsite": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}?website" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "WebsiteConfiguration" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "WebsiteConfiguration": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "WebsiteConfiguration", + "type": "structure", + "members": { + "ErrorDocument": { + "shape": "S4b" + }, + "IndexDocument": { + "shape": "S49" + }, + "RedirectAllRequestsTo": { + "shape": "S46" + }, + "RoutingRules": { + "shape": "S4c" + } + } + } + }, + "payload": "WebsiteConfiguration" + } + }, + "PutObject": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "Body": { + "streaming": true, + "type": "blob" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CacheControl": { + "location": "header", + "locationName": "Cache-Control" + }, + "ContentDisposition": { + "location": "header", + "locationName": "Content-Disposition" + }, + "ContentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "ContentLanguage": { + "location": "header", + "locationName": "Content-Language" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "integer" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "ContentType": { + "location": "header", + "locationName": "Content-Type" + }, + "Expires": { + "location": "header", + "locationName": "Expires", + "type": "timestamp" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "Metadata": { + "shape": "Sx", + "location": "headers", + "locationName": "x-amz-meta-" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "StorageClass": { + "location": "header", + "locationName": "x-amz-storage-class" + }, + "WebsiteRedirectLocation": { + "location": "header", + "locationName": "x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "payload": "Body" + }, + "output": { + "type": "structure", + "members": { + "Expiration": { + "location": "header", + "locationName": "x-amz-expiration", + "type": "timestamp" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "VersionId": { + "location": "header", + "locationName": "x-amz-version-id" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + } + } + }, + "PutObjectAcl": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key}?acl" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "ACL": { + "location": "header", + "locationName": "x-amz-acl" + }, + "AccessControlPolicy": { + "shape": "S6l", + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "AccessControlPolicy" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "GrantFullControl": { + "location": "header", + "locationName": "x-amz-grant-full-control" + }, + "GrantRead": { + "location": "header", + "locationName": "x-amz-grant-read" + }, + "GrantReadACP": { + "location": "header", + "locationName": "x-amz-grant-read-acp" + }, + "GrantWrite": { + "location": "header", + "locationName": "x-amz-grant-write" + }, + "GrantWriteACP": { + "location": "header", + "locationName": "x-amz-grant-write-acp" + }, + "Key": { + "location": "uri", + "locationName": "Key" + } + }, + "payload": "AccessControlPolicy" + } + }, + "RestoreObject": { + "http": { + "requestUri": "/{Bucket}/{Key}?restore" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "VersionId": { + "location": "querystring", + "locationName": "versionId" + }, + "RestoreRequest": { + "xmlNamespace": "http://s3.amazonaws.com/doc/2006-03-01/", + "locationName": "RestoreRequest", + "type": "structure", + "required": [ + "Days" + ], + "members": { + "Days": { + "type": "integer" + } + } + } + }, + "payload": "RestoreRequest" + }, + "alias": "PostObjectRestore" + }, + "UploadPart": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "Key", + "PartNumber", + "UploadId" + ], + "members": { + "Body": { + "streaming": true, + "type": "blob" + }, + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "ContentLength": { + "location": "header", + "locationName": "Content-Length", + "type": "integer" + }, + "ContentMD5": { + "location": "header", + "locationName": "Content-MD5" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "PartNumber": { + "location": "querystring", + "locationName": "partNumber", + "type": "integer" + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "payload": "Body" + }, + "output": { + "type": "structure", + "members": { + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "ETag": { + "location": "header", + "locationName": "ETag" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + } + } + }, + "UploadPartCopy": { + "http": { + "method": "PUT", + "requestUri": "/{Bucket}/{Key}" + }, + "input": { + "type": "structure", + "required": [ + "Bucket", + "CopySource", + "Key", + "PartNumber", + "UploadId" + ], + "members": { + "Bucket": { + "location": "uri", + "locationName": "Bucket" + }, + "CopySource": { + "location": "header", + "locationName": "x-amz-copy-source" + }, + "CopySourceIfMatch": { + "location": "header", + "locationName": "x-amz-copy-source-if-match" + }, + "CopySourceIfModifiedSince": { + "location": "header", + "locationName": "x-amz-copy-source-if-modified-since", + "type": "timestamp" + }, + "CopySourceIfNoneMatch": { + "location": "header", + "locationName": "x-amz-copy-source-if-none-match" + }, + "CopySourceIfUnmodifiedSince": { + "location": "header", + "locationName": "x-amz-copy-source-if-unmodified-since", + "type": "timestamp" + }, + "CopySourceRange": { + "location": "header", + "locationName": "x-amz-copy-source-range" + }, + "Key": { + "location": "uri", + "locationName": "Key" + }, + "PartNumber": { + "location": "querystring", + "locationName": "partNumber", + "type": "integer" + }, + "UploadId": { + "location": "querystring", + "locationName": "uploadId" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + }, + "CopySourceSSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm" + }, + "CopySourceSSECustomerKey": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-key" + }, + "CopySourceSSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + } + } + }, + "output": { + "type": "structure", + "members": { + "CopySourceVersionId": { + "location": "header", + "locationName": "x-amz-copy-source-version-id" + }, + "CopyPartResult": { + "type": "structure", + "members": { + "ETag": {}, + "LastModified": { + "type": "timestamp" + } + } + }, + "ServerSideEncryption": { + "location": "header", + "locationName": "x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5": { + "location": "header", + "locationName": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "payload": "CopyPartResult" + } + } + }, + "shapes": { + "Sx": { + "type": "map", + "key": {}, + "value": {} + }, + "S2a": { + "type": "structure", + "members": { + "DisplayName": {}, + "ID": {} + } + }, + "S2d": { + "type": "list", + "member": { + "locationName": "Grant", + "type": "structure", + "members": { + "Grantee": { + "shape": "S2f" + }, + "Permission": {} + } + } + }, + "S2f": { + "type": "structure", + "required": [ + "Type" + ], + "members": { + "DisplayName": {}, + "EmailAddress": {}, + "ID": {}, + "Type": { + "type": "string", + "xmlAttribute": true, + "locationName": "xsi:type" + }, + "URI": {} + }, + "xmlNamespace": { + "prefix": "xsi", + "uri": "http://www.w3.org/2001/XMLSchema-instance" + } + }, + "S2m": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AllowedHeaders": { + "locationName": "AllowedHeader", + "type": "list", + "member": {}, + "flattened": true + }, + "AllowedMethods": { + "locationName": "AllowedMethod", + "type": "list", + "member": {}, + "flattened": true + }, + "AllowedOrigins": { + "locationName": "AllowedOrigin", + "type": "list", + "member": {}, + "flattened": true + }, + "ExposeHeaders": { + "locationName": "ExposeHeader", + "type": "list", + "member": {}, + "flattened": true + }, + "MaxAgeSeconds": { + "type": "integer" + } + } + }, + "flattened": true + }, + "S2z": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Prefix", + "Status" + ], + "members": { + "Expiration": { + "type": "structure", + "members": { + "Date": { + "shape": "S32" + }, + "Days": { + "type": "integer" + } + } + }, + "ID": {}, + "Prefix": {}, + "Status": {}, + "Transition": { + "type": "structure", + "members": { + "Date": { + "shape": "S32" + }, + "Days": { + "type": "integer" + }, + "StorageClass": {} + } + }, + "NoncurrentVersionTransition": { + "type": "structure", + "members": { + "NoncurrentDays": { + "type": "integer" + }, + "StorageClass": {} + } + }, + "NoncurrentVersionExpiration": { + "type": "structure", + "members": { + "NoncurrentDays": { + "type": "integer" + } + } + } + } + }, + "flattened": true + }, + "S32": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "S3e": { + "type": "structure", + "members": { + "TargetBucket": {}, + "TargetGrants": { + "type": "list", + "member": { + "locationName": "Grant", + "type": "structure", + "members": { + "Grantee": { + "shape": "S2f" + }, + "Permission": {} + } + } + }, + "TargetPrefix": {} + } + }, + "S3m": { + "type": "structure", + "members": { + "Event": {}, + "Topic": {} + } + }, + "S3x": { + "type": "list", + "member": { + "locationName": "Tag", + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": {} + } + } + }, + "S46": { + "type": "structure", + "required": [ + "HostName" + ], + "members": { + "HostName": {}, + "Protocol": {} + } + }, + "S49": { + "type": "structure", + "required": [ + "Suffix" + ], + "members": { + "Suffix": {} + } + }, + "S4b": { + "type": "structure", + "required": [ + "Key" + ], + "members": { + "Key": {} + } + }, + "S4c": { + "type": "list", + "member": { + "locationName": "RoutingRule", + "type": "structure", + "required": [ + "Redirect" + ], + "members": { + "Condition": { + "type": "structure", + "members": { + "HttpErrorCodeReturnedEquals": {}, + "KeyPrefixEquals": {} + } + }, + "Redirect": { + "type": "structure", + "members": { + "HostName": {}, + "HttpRedirectCode": {}, + "Protocol": {}, + "ReplaceKeyPrefixWith": {}, + "ReplaceKeyWith": {} + } + } + } + } + }, + "S5r": { + "type": "structure", + "members": { + "ID": {}, + "DisplayName": {} + } + }, + "S5s": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Prefix": {} + } + }, + "flattened": true + }, + "S6l": { + "type": "structure", + "members": { + "Grants": { + "shape": "S2d", + "locationName": "AccessControlList" + }, + "Owner": { + "shape": "S2a" + } + } + } + } +} \ No newline at end of file diff --git a/apis/s3-2006-03-01.full.json b/apis/s3-2006-03-01.full.json new file mode 100644 index 0000000000..7dc41ec947 --- /dev/null +++ b/apis/s3-2006-03-01.full.json @@ -0,0 +1,4199 @@ +{ + "metadata":{ + "apiVersion":"2006-03-01", + "checksumFormat":"md5", + "endpointPrefix":"s3", + "globalEndpoint":"s3.amazonaws.com", + "serviceAbbreviation":"Amazon S3", + "serviceFullName":"Amazon Simple Storage Service", + "signatureVersion":"s3", + "timestampFormat":"rfc822", + "protocol":"rest-xml" + }, + "operations":{ + "AbortMultipartUpload":{ + "name":"AbortMultipartUpload", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"AbortMultipartUploadRequest"}, + "errors":[ + { + "shape":"NoSuchUpload", + "exception":true, + "documentation":"The specified multipart upload does not exist." + } + ], + "documentation":"

Aborts a multipart upload.

\n

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html" + }, + "CompleteMultipartUpload":{ + "name":"CompleteMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"CompleteMultipartUploadRequest"}, + "output":{"shape":"CompleteMultipartUploadOutput"}, + "documentation":"Completes a multipart upload by assembling previously uploaded parts.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html" + }, + "CopyObject":{ + "name":"CopyObject", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"CopyObjectRequest"}, + "output":{"shape":"CopyObjectOutput"}, + "errors":[ + { + "shape":"ObjectNotInActiveTierError", + "exception":true, + "documentation":"The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier." + } + ], + "documentation":"Creates a copy of an object that is already stored in Amazon S3.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html", + "alias":"PutObjectCopy" + }, + "CreateBucket":{ + "name":"CreateBucket", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"CreateBucketRequest"}, + "output":{"shape":"CreateBucketOutput"}, + "errors":[ + { + "shape":"BucketAlreadyExists", + "exception":true, + "documentation":"The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again." + } + ], + "documentation":"Creates a new bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html", + "alias":"PutBucket" + }, + "CreateMultipartUpload":{ + "name":"CreateMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key}?uploads" + }, + "input":{"shape":"CreateMultipartUploadRequest"}, + "output":{"shape":"CreateMultipartUploadOutput"}, + "documentation":"

Initiates a multipart upload and returns an upload ID.

\n

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html", + "alias":"InitiateMultipartUpload" + }, + "DeleteBucket":{ + "name":"DeleteBucket", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"DeleteBucketRequest"}, + "documentation":"Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html" + }, + "DeleteBucketCors":{ + "name":"DeleteBucketCors", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?cors" + }, + "input":{"shape":"DeleteBucketCorsRequest"}, + "documentation":"Deletes the cors configuration information set for the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html" + }, + "DeleteBucketLifecycle":{ + "name":"DeleteBucketLifecycle", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"DeleteBucketLifecycleRequest"}, + "documentation":"Deletes the lifecycle configuration from the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html" + }, + "DeleteBucketPolicy":{ + "name":"DeleteBucketPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?policy" + }, + "input":{"shape":"DeleteBucketPolicyRequest"}, + "documentation":"Deletes the policy from the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html" + }, + "DeleteBucketTagging":{ + "name":"DeleteBucketTagging", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?tagging" + }, + "input":{"shape":"DeleteBucketTaggingRequest"}, + "documentation":"Deletes the tags from the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html" + }, + "DeleteBucketWebsite":{ + "name":"DeleteBucketWebsite", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?website" + }, + "input":{"shape":"DeleteBucketWebsiteRequest"}, + "documentation":"This operation removes the website configuration from the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html" + }, + "DeleteObject":{ + "name":"DeleteObject", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"DeleteObjectRequest"}, + "output":{"shape":"DeleteObjectOutput"}, + "documentation":"Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html" + }, + "DeleteObjects":{ + "name":"DeleteObjects", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}?delete" + }, + "input":{"shape":"DeleteObjectsRequest"}, + "output":{"shape":"DeleteObjectsOutput"}, + "documentation":"This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html", + "alias":"DeleteMultipleObjects" + }, + "GetBucketAcl":{ + "name":"GetBucketAcl", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?acl" + }, + "input":{"shape":"GetBucketAclRequest"}, + "output":{"shape":"GetBucketAclOutput"}, + "documentation":"Gets the access control policy for the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html" + }, + "GetBucketCors":{ + "name":"GetBucketCors", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?cors" + }, + "input":{"shape":"GetBucketCorsRequest"}, + "output":{"shape":"GetBucketCorsOutput"}, + "documentation":"Returns the cors configuration for the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html" + }, + "GetBucketLifecycle":{ + "name":"GetBucketLifecycle", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"GetBucketLifecycleRequest"}, + "output":{"shape":"GetBucketLifecycleOutput"}, + "documentation":"Returns the lifecycle configuration information set on the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html" + }, + "GetBucketLocation":{ + "name":"GetBucketLocation", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?location" + }, + "input":{"shape":"GetBucketLocationRequest"}, + "output":{"shape":"GetBucketLocationOutput"}, + "documentation":"Returns the region the bucket resides in.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html" + }, + "GetBucketLogging":{ + "name":"GetBucketLogging", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?logging" + }, + "input":{"shape":"GetBucketLoggingRequest"}, + "output":{"shape":"GetBucketLoggingOutput"}, + "documentation":"Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html" + }, + "GetBucketNotification":{ + "name":"GetBucketNotification", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"GetBucketNotificationRequest"}, + "output":{"shape":"GetBucketNotificationOutput"}, + "documentation":"Return the notification configuration of a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html" + }, + "GetBucketPolicy":{ + "name":"GetBucketPolicy", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?policy" + }, + "input":{"shape":"GetBucketPolicyRequest"}, + "output":{"shape":"GetBucketPolicyOutput"}, + "documentation":"Returns the policy of a specified bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html" + }, + "GetBucketRequestPayment":{ + "name":"GetBucketRequestPayment", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?requestPayment" + }, + "input":{"shape":"GetBucketRequestPaymentRequest"}, + "output":{"shape":"GetBucketRequestPaymentOutput"}, + "documentation":"Returns the request payment configuration of a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html" + }, + "GetBucketTagging":{ + "name":"GetBucketTagging", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?tagging" + }, + "input":{"shape":"GetBucketTaggingRequest"}, + "output":{"shape":"GetBucketTaggingOutput"}, + "documentation":"Returns the tag set associated with the bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html" + }, + "GetBucketVersioning":{ + "name":"GetBucketVersioning", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?versioning" + }, + "input":{"shape":"GetBucketVersioningRequest"}, + "output":{"shape":"GetBucketVersioningOutput"}, + "documentation":"Returns the versioning state of a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html" + }, + "GetBucketWebsite":{ + "name":"GetBucketWebsite", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?website" + }, + "input":{"shape":"GetBucketWebsiteRequest"}, + "output":{"shape":"GetBucketWebsiteOutput"}, + "documentation":"Returns the website configuration for a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html" + }, + "GetObject":{ + "name":"GetObject", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"GetObjectRequest"}, + "output":{"shape":"GetObjectOutput"}, + "errors":[ + { + "shape":"NoSuchKey", + "exception":true, + "documentation":"The specified key does not exist." + } + ], + "documentation":"Retrieves objects from Amazon S3.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html" + }, + "GetObjectAcl":{ + "name":"GetObjectAcl", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key}?acl" + }, + "input":{"shape":"GetObjectAclRequest"}, + "output":{"shape":"GetObjectAclOutput"}, + "errors":[ + { + "shape":"NoSuchKey", + "exception":true, + "documentation":"The specified key does not exist." + } + ], + "documentation":"Returns the access control list (ACL) of an object.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html" + }, + "GetObjectTorrent":{ + "name":"GetObjectTorrent", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key}?torrent" + }, + "input":{"shape":"GetObjectTorrentRequest"}, + "output":{"shape":"GetObjectTorrentOutput"}, + "documentation":"Return torrent files from a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html" + }, + "HeadBucket":{ + "name":"HeadBucket", + "http":{ + "method":"HEAD", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"HeadBucketRequest"}, + "errors":[ + { + "shape":"NoSuchBucket", + "exception":true, + "documentation":"The specified bucket does not exist." + } + ], + "documentation":"This operation is useful to determine if a bucket exists and you have permission to access it.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html" + }, + "HeadObject":{ + "name":"HeadObject", + "http":{ + "method":"HEAD", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"HeadObjectRequest"}, + "output":{"shape":"HeadObjectOutput"}, + "errors":[ + { + "shape":"NoSuchKey", + "exception":true, + "documentation":"The specified key does not exist." + } + ], + "documentation":"The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html" + }, + "ListBuckets":{ + "name":"ListBuckets", + "http":{ + "method":"GET", + "requestUri":"/" + }, + "output":{"shape":"ListBucketsOutput"}, + "documentation":"Returns a list of all buckets owned by the authenticated sender of the request.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html", + "alias":"GetService" + }, + "ListMultipartUploads":{ + "name":"ListMultipartUploads", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?uploads" + }, + "input":{"shape":"ListMultipartUploadsRequest"}, + "output":{"shape":"ListMultipartUploadsOutput"}, + "documentation":"This operation lists in-progress multipart uploads.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html" + }, + "ListObjectVersions":{ + "name":"ListObjectVersions", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?versions" + }, + "input":{"shape":"ListObjectVersionsRequest"}, + "output":{"shape":"ListObjectVersionsOutput"}, + "documentation":"Returns metadata about all of the versions of objects in a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html", + "alias":"GetBucketObjectVersions" + }, + "ListObjects":{ + "name":"ListObjects", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"ListObjectsRequest"}, + "output":{"shape":"ListObjectsOutput"}, + "errors":[ + { + "shape":"NoSuchBucket", + "exception":true, + "documentation":"The specified bucket does not exist." + } + ], + "documentation":"Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html", + "alias":"GetBucket" + }, + "ListParts":{ + "name":"ListParts", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"ListPartsRequest"}, + "output":{"shape":"ListPartsOutput"}, + "documentation":"Lists the parts that have been uploaded for a specific multipart upload.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html" + }, + "PutBucketAcl":{ + "name":"PutBucketAcl", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?acl" + }, + "input":{"shape":"PutBucketAclRequest"}, + "documentation":"Sets the permissions on a bucket using access control lists (ACL).", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html" + }, + "PutBucketCors":{ + "name":"PutBucketCors", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?cors" + }, + "input":{"shape":"PutBucketCorsRequest"}, + "documentation":"Sets the cors configuration for a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html" + }, + "PutBucketLifecycle":{ + "name":"PutBucketLifecycle", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"PutBucketLifecycleRequest"}, + "documentation":"Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html" + }, + "PutBucketLogging":{ + "name":"PutBucketLogging", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?logging" + }, + "input":{"shape":"PutBucketLoggingRequest"}, + "documentation":"Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html" + }, + "PutBucketNotification":{ + "name":"PutBucketNotification", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"PutBucketNotificationRequest"}, + "documentation":"Enables notifications of specified events for a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html" + }, + "PutBucketPolicy":{ + "name":"PutBucketPolicy", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?policy" + }, + "input":{ + "shape":"PutBucketPolicyRequest", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"PutBucketPolicyRequest" + }, + "documentation":"Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html" + }, + "PutBucketRequestPayment":{ + "name":"PutBucketRequestPayment", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?requestPayment" + }, + "input":{"shape":"PutBucketRequestPaymentRequest"}, + "documentation":"Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html" + }, + "PutBucketTagging":{ + "name":"PutBucketTagging", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?tagging" + }, + "input":{"shape":"PutBucketTaggingRequest"}, + "documentation":"Sets the tags for a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html" + }, + "PutBucketVersioning":{ + "name":"PutBucketVersioning", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?versioning" + }, + "input":{"shape":"PutBucketVersioningRequest"}, + "documentation":"Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html" + }, + "PutBucketWebsite":{ + "name":"PutBucketWebsite", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?website" + }, + "input":{"shape":"PutBucketWebsiteRequest"}, + "documentation":"Set the website configuration for a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html" + }, + "PutObject":{ + "name":"PutObject", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"PutObjectRequest"}, + "output":{"shape":"PutObjectOutput"}, + "documentation":"Adds an object to a bucket.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html" + }, + "PutObjectAcl":{ + "name":"PutObjectAcl", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key}?acl" + }, + "input":{"shape":"PutObjectAclRequest"}, + "errors":[ + { + "shape":"NoSuchKey", + "exception":true, + "documentation":"The specified key does not exist." + } + ], + "documentation":"uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html" + }, + "RestoreObject":{ + "name":"RestoreObject", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key}?restore" + }, + "input":{"shape":"RestoreObjectRequest"}, + "errors":[ + { + "shape":"ObjectAlreadyInActiveTierError", + "exception":true, + "documentation":"This operation is not allowed against this storage tier" + } + ], + "documentation":"Restores an archived copy of an object back into Amazon S3", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html", + "alias":"PostObjectRestore" + }, + "UploadPart":{ + "name":"UploadPart", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"UploadPartRequest"}, + "output":{"shape":"UploadPartOutput"}, + "documentation":"

Uploads a part in a multipart upload.

\n

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html" + }, + "UploadPartCopy":{ + "name":"UploadPartCopy", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key}" + }, + "input":{"shape":"UploadPartCopyRequest"}, + "output":{"shape":"UploadPartCopyOutput"}, + "documentation":"Uploads a part by copying data from an existing object as data source.", + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html" + } + }, + "shapes":{ + "AbortMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId" + } + } + }, + "AcceptRanges":{"type":"string"}, + "AccessControlPolicy":{ + "type":"structure", + "members":{ + "Grants":{ + "shape":"Grants", + "documentation":"A list of grants.", + "locationName":"AccessControlList" + }, + "Owner":{"shape":"Owner"} + } + }, + "AllowedHeader":{"type":"string"}, + "AllowedHeaders":{ + "type":"list", + "member":{"shape":"AllowedHeader"}, + "flattened":true + }, + "AllowedMethod":{"type":"string"}, + "AllowedMethods":{ + "type":"list", + "member":{"shape":"AllowedMethod"}, + "flattened":true + }, + "AllowedOrigin":{"type":"string"}, + "AllowedOrigins":{ + "type":"list", + "member":{"shape":"AllowedOrigin"}, + "flattened":true + }, + "Body":{"type":"blob"}, + "Bucket":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"BucketName", + "documentation":"The name of the bucket." + }, + "CreationDate":{ + "shape":"CreationDate", + "documentation":"Date the bucket was created." + } + } + }, + "BucketAlreadyExists":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again." + }, + "BucketCannedACL":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "authenticated-read" + ] + }, + "BucketLocationConstraint":{ + "type":"string", + "enum":[ + "EU", + "eu-west-1", + "us-west-1", + "us-west-2", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "sa-east-1", + "" + ] + }, + "BucketLoggingStatus":{ + "type":"structure", + "members":{ + "LoggingEnabled":{"shape":"LoggingEnabled"} + } + }, + "BucketLogsPermission":{ + "type":"string", + "enum":[ + "FULL_CONTROL", + "READ", + "WRITE" + ] + }, + "BucketName":{"type":"string"}, + "BucketVersioningStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Suspended" + ] + }, + "Buckets":{ + "type":"list", + "member":{ + "shape":"Bucket", + "locationName":"Bucket" + } + }, + "CORSConfiguration":{ + "type":"structure", + "members":{ + "CORSRules":{ + "shape":"CORSRules", + "locationName":"CORSRule" + } + } + }, + "CORSRule":{ + "type":"structure", + "members":{ + "AllowedHeaders":{ + "shape":"AllowedHeaders", + "documentation":"Specifies which headers are allowed in a pre-flight OPTIONS request.", + "locationName":"AllowedHeader" + }, + "AllowedMethods":{ + "shape":"AllowedMethods", + "documentation":"Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.", + "locationName":"AllowedMethod" + }, + "AllowedOrigins":{ + "shape":"AllowedOrigins", + "documentation":"One or more origins you want customers to be able to access the bucket from.", + "locationName":"AllowedOrigin" + }, + "ExposeHeaders":{ + "shape":"ExposeHeaders", + "documentation":"One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).", + "locationName":"ExposeHeader" + }, + "MaxAgeSeconds":{ + "shape":"MaxAgeSeconds", + "documentation":"The time in seconds that your browser is to cache the preflight response for the specified resource." + } + } + }, + "CORSRules":{ + "type":"list", + "member":{"shape":"CORSRule"}, + "flattened":true + }, + "CacheControl":{"type":"string"}, + "Code":{"type":"string"}, + "CommonPrefix":{ + "type":"structure", + "members":{ + "Prefix":{"shape":"Prefix"} + } + }, + "CommonPrefixList":{ + "type":"list", + "member":{"shape":"CommonPrefix"}, + "flattened":true + }, + "CompleteMultipartUploadOutput":{ + "type":"structure", + "members":{ + "Location":{"shape":"Location"}, + "Bucket":{"shape":"BucketName"}, + "Key":{"shape":"ObjectKey"}, + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration", + "documentation":"If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded." + }, + "ETag":{ + "shape":"ETag", + "documentation":"Entity tag of the object." + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id", + "documentation":"Version of the object." + } + } + }, + "CompleteMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "MultipartUpload":{ + "shape":"CompletedMultipartUpload", + "locationName":"CompleteMultipartUpload", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId" + } + }, + "payload":"MultipartUpload" + }, + "CompletedMultipartUpload":{ + "type":"structure", + "members":{ + "Parts":{ + "shape":"CompletedPartList", + "locationName":"Part" + } + } + }, + "CompletedPart":{ + "type":"structure", + "members":{ + "ETag":{ + "shape":"ETag", + "documentation":"Entity tag returned when the part was uploaded." + }, + "PartNumber":{ + "shape":"PartNumber", + "documentation":"Part number that identifies the part." + } + } + }, + "CompletedPartList":{ + "type":"list", + "member":{"shape":"CompletedPart"}, + "flattened":true + }, + "Condition":{ + "type":"structure", + "members":{ + "HttpErrorCodeReturnedEquals":{ + "shape":"HttpErrorCodeReturnedEquals", + "documentation":"The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied." + }, + "KeyPrefixEquals":{ + "shape":"KeyPrefixEquals", + "documentation":"The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied." + } + } + }, + "ContentDisposition":{"type":"string"}, + "ContentEncoding":{"type":"string"}, + "ContentLanguage":{"type":"string"}, + "ContentLength":{"type":"integer"}, + "ContentMD5":{"type":"string"}, + "ContentType":{"type":"string"}, + "CopyObjectOutput":{ + "type":"structure", + "members":{ + "CopyObjectResult":{"shape":"CopyObjectResult"}, + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration", + "documentation":"If the object expiration is configured, the response includes this header." + }, + "CopySourceVersionId":{ + "shape":"CopySourceVersionId", + "location":"header", + "locationName":"x-amz-copy-source-version-id" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." + } + }, + "payload":"CopyObjectResult" + }, + "CopyObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "CopySource", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "location":"header", + "locationName":"x-amz-acl", + "documentation":"The canned ACL to apply to the object." + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control", + "documentation":"Specifies caching behavior along the request/reply chain." + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition", + "documentation":"Specifies presentational information for the object." + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding", + "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language", + "documentation":"The language the content is in." + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type", + "documentation":"A standard MIME type describing the format of the object data." + }, + "CopySource":{ + "shape":"CopySource", + "location":"header", + "locationName":"x-amz-copy-source", + "documentation":"The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded." + }, + "CopySourceIfMatch":{ + "shape":"CopySourceIfMatch", + "location":"header", + "locationName":"x-amz-copy-source-if-match", + "documentation":"Copies the object if its entity tag (ETag) matches the specified tag." + }, + "CopySourceIfModifiedSince":{ + "shape":"CopySourceIfModifiedSince", + "location":"header", + "locationName":"x-amz-copy-source-if-modified-since", + "documentation":"Copies the object if it has been modified since the specified time." + }, + "CopySourceIfNoneMatch":{ + "shape":"CopySourceIfNoneMatch", + "location":"header", + "locationName":"x-amz-copy-source-if-none-match", + "documentation":"Copies the object if its entity tag (ETag) is different than the specified ETag." + }, + "CopySourceIfUnmodifiedSince":{ + "shape":"CopySourceIfUnmodifiedSince", + "location":"header", + "locationName":"x-amz-copy-source-if-unmodified-since", + "documentation":"Copies the object if it hasn't been modified since the specified time." + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires", + "documentation":"The date and time at which the object is no longer cacheable." + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control", + "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read", + "documentation":"Allows grantee to read the object data and its metadata." + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp", + "documentation":"Allows grantee to read the object ACL." + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp", + "documentation":"Allows grantee to write the ACL for the applicable object." + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "documentation":"A map of metadata to store with the object in S3.", + "locationName":"x-amz-meta-" + }, + "MetadataDirective":{ + "shape":"MetadataDirective", + "location":"header", + "locationName":"x-amz-metadata-directive", + "documentation":"Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request." + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "StorageClass":{ + "shape":"StorageClass", + "location":"header", + "locationName":"x-amz-storage-class", + "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'." + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location", + "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256)." + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + }, + "CopySourceSSECustomerAlgorithm":{ + "shape":"CopySourceSSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use when decrypting the source object (e.g., AES256)." + }, + "CopySourceSSECustomerKey":{ + "shape":"CopySourceSSECustomerKey", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created." + }, + "CopySourceSSECustomerKeyMD5":{ + "shape":"CopySourceSSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + } + }, + "CopyObjectResult":{ + "type":"structure", + "members":{ + "ETag":{"shape":"ETag"}, + "LastModified":{"shape":"LastModified"} + } + }, + "CopyPartResult":{ + "type":"structure", + "members":{ + "ETag":{ + "shape":"ETag", + "documentation":"Entity tag of the object." + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"Date and time at which the object was uploaded." + } + } + }, + "CopySource":{ + "type":"string", + "pattern":"\\/.+\\/.+" + }, + "CopySourceIfMatch":{"type":"string"}, + "CopySourceIfModifiedSince":{"type":"timestamp"}, + "CopySourceIfNoneMatch":{"type":"string"}, + "CopySourceIfUnmodifiedSince":{"type":"timestamp"}, + "CopySourceRange":{"type":"string"}, + "CopySourceSSECustomerAlgorithm":{"type":"string"}, + "CopySourceSSECustomerKey":{"type":"string"}, + "CopySourceSSECustomerKeyMD5":{"type":"string"}, + "CopySourceVersionId":{"type":"string"}, + "CreateBucketConfiguration":{ + "type":"structure", + "members":{ + "LocationConstraint":{ + "shape":"BucketLocationConstraint", + "documentation":"Specifies the region where the bucket will be created." + } + } + }, + "CreateBucketOutput":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"Location", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "ACL":{ + "shape":"BucketCannedACL", + "location":"header", + "locationName":"x-amz-acl", + "documentation":"The canned ACL to apply to the bucket." + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CreateBucketConfiguration":{ + "shape":"CreateBucketConfiguration", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"CreateBucketConfiguration" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control", + "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read", + "documentation":"Allows grantee to list the objects in the bucket." + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp", + "documentation":"Allows grantee to read the bucket ACL." + }, + "GrantWrite":{ + "shape":"GrantWrite", + "location":"header", + "locationName":"x-amz-grant-write", + "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket." + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp", + "documentation":"Allows grantee to write the ACL for the applicable bucket." + } + }, + "payload":"CreateBucketConfiguration" + }, + "CreateMultipartUploadOutput":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"Name of the bucket to which the multipart upload was initiated.", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"Object key for which the multipart upload was initiated." + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"ID for the initiated multipart upload." + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." + } + } + }, + "CreateMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "location":"header", + "locationName":"x-amz-acl", + "documentation":"The canned ACL to apply to the object." + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control", + "documentation":"Specifies caching behavior along the request/reply chain." + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition", + "documentation":"Specifies presentational information for the object." + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding", + "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language", + "documentation":"The language the content is in." + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type", + "documentation":"A standard MIME type describing the format of the object data." + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires", + "documentation":"The date and time at which the object is no longer cacheable." + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control", + "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read", + "documentation":"Allows grantee to read the object data and its metadata." + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp", + "documentation":"Allows grantee to read the object ACL." + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp", + "documentation":"Allows grantee to write the ACL for the applicable object." + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "documentation":"A map of metadata to store with the object in S3.", + "locationName":"x-amz-meta-" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "StorageClass":{ + "shape":"StorageClass", + "location":"header", + "locationName":"x-amz-storage-class", + "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'." + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location", + "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256)." + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + } + }, + "CreationDate":{"type":"timestamp"}, + "Date":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "Days":{"type":"integer"}, + "Delete":{ + "type":"structure", + "required":["Objects"], + "members":{ + "Objects":{ + "shape":"ObjectIdentifierList", + "locationName":"Object" + }, + "Quiet":{ + "shape":"Quiet", + "documentation":"Element to enable quiet mode for the request. When you add this element, you must set its value to true." + } + } + }, + "DeleteBucketCorsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketPolicyRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketTaggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketWebsiteRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteMarker":{"type":"boolean"}, + "DeleteMarkerEntry":{ + "type":"structure", + "members":{ + "Owner":{"shape":"Owner"}, + "Key":{ + "shape":"ObjectKey", + "documentation":"The object key." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"Version ID of an object." + }, + "IsLatest":{ + "shape":"IsLatest", + "documentation":"Specifies whether the object is (true) or is not (false) the latest version of an object." + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"Date and time the object was last modified." + } + } + }, + "DeleteMarkerVersionId":{"type":"string"}, + "DeleteMarkers":{ + "type":"list", + "member":{"shape":"DeleteMarkerEntry"}, + "flattened":true + }, + "DeleteObjectOutput":{ + "type":"structure", + "members":{ + "DeleteMarker":{ + "shape":"DeleteMarker", + "location":"header", + "locationName":"x-amz-delete-marker", + "documentation":"Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id", + "documentation":"Returns the version ID of the delete marker created as a result of the DELETE operation." + } + } + }, + "DeleteObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "MFA":{ + "shape":"MFA", + "location":"header", + "locationName":"x-amz-mfa", + "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId", + "documentation":"VersionId used to reference a specific version of the object." + } + } + }, + "DeleteObjectsOutput":{ + "type":"structure", + "members":{ + "Deleted":{"shape":"DeletedObjects"}, + "Errors":{ + "shape":"Errors", + "locationName":"Error" + } + } + }, + "DeleteObjectsRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Delete" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delete":{ + "shape":"Delete", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"Delete" + }, + "MFA":{ + "shape":"MFA", + "location":"header", + "locationName":"x-amz-mfa", + "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." + } + }, + "payload":"Delete" + }, + "DeletedObject":{ + "type":"structure", + "members":{ + "Key":{"shape":"ObjectKey"}, + "VersionId":{"shape":"ObjectVersionId"}, + "DeleteMarker":{"shape":"DeleteMarker"}, + "DeleteMarkerVersionId":{"shape":"DeleteMarkerVersionId"} + } + }, + "DeletedObjects":{ + "type":"list", + "member":{"shape":"DeletedObject"}, + "flattened":true + }, + "Delimiter":{"type":"string"}, + "DisplayName":{"type":"string"}, + "ETag":{"type":"string"}, + "EmailAddress":{"type":"string"}, + "EncodingType":{ + "type":"string", + "enum":["url"], + "documentation":"Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response." + }, + "Error":{ + "type":"structure", + "members":{ + "Key":{"shape":"ObjectKey"}, + "VersionId":{"shape":"ObjectVersionId"}, + "Code":{"shape":"Code"}, + "Message":{"shape":"Message"} + } + }, + "ErrorDocument":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"The object key name to use when a 4XX class error occurs." + } + } + }, + "Errors":{ + "type":"list", + "member":{"shape":"Error"}, + "flattened":true + }, + "Event":{ + "type":"string", + "enum":["s3:ReducedRedundancyLostObject"] + }, + "Expiration":{"type":"timestamp"}, + "ExpirationStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "Expires":{"type":"timestamp"}, + "ExposeHeader":{"type":"string"}, + "ExposeHeaders":{ + "type":"list", + "member":{"shape":"ExposeHeader"}, + "flattened":true + }, + "GetBucketAclOutput":{ + "type":"structure", + "members":{ + "Owner":{"shape":"Owner"}, + "Grants":{ + "shape":"Grants", + "documentation":"A list of grants.", + "locationName":"AccessControlList" + } + } + }, + "GetBucketAclRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketCorsOutput":{ + "type":"structure", + "members":{ + "CORSRules":{ + "shape":"CORSRules", + "locationName":"CORSRule" + } + } + }, + "GetBucketCorsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLifecycleOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"Rules", + "locationName":"Rule" + } + } + }, + "GetBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLocationOutput":{ + "type":"structure", + "members":{ + "LocationConstraint":{"shape":"BucketLocationConstraint"} + } + }, + "GetBucketLocationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLoggingOutput":{ + "type":"structure", + "members":{ + "LoggingEnabled":{"shape":"LoggingEnabled"} + } + }, + "GetBucketLoggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketNotificationOutput":{ + "type":"structure", + "members":{ + "TopicConfiguration":{"shape":"TopicConfiguration"} + } + }, + "GetBucketNotificationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketPolicyOutput":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"The bucket policy as a JSON document." + } + }, + "payload":"Policy" + }, + "GetBucketPolicyRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketRequestPaymentOutput":{ + "type":"structure", + "members":{ + "Payer":{ + "shape":"Payer", + "documentation":"Specifies who pays for the download and request fees." + } + } + }, + "GetBucketRequestPaymentRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketTaggingOutput":{ + "type":"structure", + "required":["TagSet"], + "members":{ + "TagSet":{"shape":"TagSet"} + } + }, + "GetBucketTaggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketVersioningOutput":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BucketVersioningStatus", + "documentation":"The versioning state of the bucket." + }, + "MFADelete":{ + "shape":"MFADeleteStatus", + "documentation":"Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.", + "locationName":"MfaDelete" + } + } + }, + "GetBucketVersioningRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketWebsiteOutput":{ + "type":"structure", + "members":{ + "RedirectAllRequestsTo":{"shape":"RedirectAllRequestsTo"}, + "IndexDocument":{"shape":"IndexDocument"}, + "ErrorDocument":{"shape":"ErrorDocument"}, + "RoutingRules":{"shape":"RoutingRules"} + } + }, + "GetBucketWebsiteRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetObjectAclOutput":{ + "type":"structure", + "members":{ + "Owner":{"shape":"Owner"}, + "Grants":{ + "shape":"Grants", + "documentation":"A list of grants.", + "locationName":"AccessControlList" + } + } + }, + "GetObjectAclRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId", + "documentation":"VersionId used to reference a specific version of the object." + } + } + }, + "GetObjectOutput":{ + "type":"structure", + "members":{ + "Body":{ + "shape":"Body", + "streaming":true, + "documentation":"Object data." + }, + "DeleteMarker":{ + "shape":"DeleteMarker", + "location":"header", + "locationName":"x-amz-delete-marker", + "documentation":"Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response." + }, + "AcceptRanges":{ + "shape":"AcceptRanges", + "location":"header", + "locationName":"accept-ranges" + }, + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration", + "documentation":"If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded." + }, + "Restore":{ + "shape":"Restore", + "location":"header", + "locationName":"x-amz-restore", + "documentation":"Provides information about object restoration operation and expiration time of the restored object copy." + }, + "LastModified":{ + "shape":"LastModified", + "location":"header", + "locationName":"Last-Modified", + "documentation":"Last modified date of the object" + }, + "ContentLength":{ + "shape":"ContentLength", + "location":"header", + "locationName":"Content-Length", + "documentation":"Size of the body in bytes." + }, + "ETag":{ + "shape":"ETag", + "location":"header", + "locationName":"ETag", + "documentation":"An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL" + }, + "MissingMeta":{ + "shape":"MissingMeta", + "location":"header", + "locationName":"x-amz-missing-meta", + "documentation":"This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id", + "documentation":"Version of the object." + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control", + "documentation":"Specifies caching behavior along the request/reply chain." + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition", + "documentation":"Specifies presentational information for the object." + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding", + "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language", + "documentation":"The language the content is in." + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type", + "documentation":"A standard MIME type describing the format of the object data." + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires", + "documentation":"The date and time at which the object is no longer cacheable." + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location", + "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "documentation":"A map of metadata to store with the object in S3.", + "locationName":"x-amz-meta-" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." + } + }, + "payload":"Body" + }, + "GetObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "IfMatch":{ + "shape":"IfMatch", + "location":"header", + "locationName":"If-Match", + "documentation":"Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed)." + }, + "IfModifiedSince":{ + "shape":"IfModifiedSince", + "location":"header", + "locationName":"If-Modified-Since", + "documentation":"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified)." + }, + "IfNoneMatch":{ + "shape":"IfNoneMatch", + "location":"header", + "locationName":"If-None-Match", + "documentation":"Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified)." + }, + "IfUnmodifiedSince":{ + "shape":"IfUnmodifiedSince", + "location":"header", + "locationName":"If-Unmodified-Since", + "documentation":"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed)." + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Range":{ + "shape":"Range", + "location":"header", + "locationName":"Range", + "documentation":"Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35." + }, + "ResponseCacheControl":{ + "shape":"ResponseCacheControl", + "location":"querystring", + "locationName":"response-cache-control", + "documentation":"Sets the Cache-Control header of the response." + }, + "ResponseContentDisposition":{ + "shape":"ResponseContentDisposition", + "location":"querystring", + "locationName":"response-content-disposition", + "documentation":"Sets the Content-Disposition header of the response" + }, + "ResponseContentEncoding":{ + "shape":"ResponseContentEncoding", + "location":"querystring", + "locationName":"response-content-encoding", + "documentation":"Sets the Content-Encoding header of the response." + }, + "ResponseContentLanguage":{ + "shape":"ResponseContentLanguage", + "location":"querystring", + "locationName":"response-content-language", + "documentation":"Sets the Content-Language header of the response." + }, + "ResponseContentType":{ + "shape":"ResponseContentType", + "location":"querystring", + "locationName":"response-content-type", + "documentation":"Sets the Content-Type header of the response." + }, + "ResponseExpires":{ + "shape":"ResponseExpires", + "location":"querystring", + "locationName":"response-expires", + "documentation":"Sets the Expires header of the response." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId", + "documentation":"VersionId used to reference a specific version of the object." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256)." + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + } + }, + "GetObjectTorrentOutput":{ + "type":"structure", + "members":{ + "Body":{ + "shape":"Body", + "streaming":true + } + }, + "payload":"Body" + }, + "GetObjectTorrentRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + } + } + }, + "Grant":{ + "type":"structure", + "members":{ + "Grantee":{"shape":"Grantee"}, + "Permission":{ + "shape":"Permission", + "documentation":"Specifies the permission given to the grantee." + } + } + }, + "GrantFullControl":{"type":"string"}, + "GrantRead":{"type":"string"}, + "GrantReadACP":{"type":"string"}, + "GrantWrite":{"type":"string"}, + "GrantWriteACP":{"type":"string"}, + "Grantee":{ + "type":"structure", + "required":["Type"], + "members":{ + "DisplayName":{ + "shape":"DisplayName", + "documentation":"Screen name of the grantee." + }, + "EmailAddress":{ + "shape":"EmailAddress", + "documentation":"Email address of the grantee." + }, + "ID":{ + "shape":"ID", + "documentation":"The canonical user ID of the grantee." + }, + "Type":{ + "shape":"Type", + "documentation":"Type of grantee" + }, + "URI":{ + "shape":"URI", + "documentation":"URI of the grantee group." + } + }, + "xmlNamespace":{ + "prefix":"xsi", + "uri":"http://www.w3.org/2001/XMLSchema-instance" + } + }, + "Grants":{ + "type":"list", + "member":{ + "shape":"Grant", + "locationName":"Grant" + } + }, + "HeadBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "HeadObjectOutput":{ + "type":"structure", + "members":{ + "DeleteMarker":{ + "shape":"DeleteMarker", + "location":"header", + "locationName":"x-amz-delete-marker", + "documentation":"Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response." + }, + "AcceptRanges":{ + "shape":"AcceptRanges", + "location":"header", + "locationName":"accept-ranges" + }, + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration", + "documentation":"If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded." + }, + "Restore":{ + "shape":"Restore", + "location":"header", + "locationName":"x-amz-restore", + "documentation":"Provides information about object restoration operation and expiration time of the restored object copy." + }, + "LastModified":{ + "shape":"LastModified", + "location":"header", + "locationName":"Last-Modified", + "documentation":"Last modified date of the object" + }, + "ContentLength":{ + "shape":"ContentLength", + "location":"header", + "locationName":"Content-Length", + "documentation":"Size of the body in bytes." + }, + "ETag":{ + "shape":"ETag", + "location":"header", + "locationName":"ETag", + "documentation":"An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL" + }, + "MissingMeta":{ + "shape":"MissingMeta", + "location":"header", + "locationName":"x-amz-missing-meta", + "documentation":"This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id", + "documentation":"Version of the object." + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control", + "documentation":"Specifies caching behavior along the request/reply chain." + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition", + "documentation":"Specifies presentational information for the object." + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding", + "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language", + "documentation":"The language the content is in." + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type", + "documentation":"A standard MIME type describing the format of the object data." + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires", + "documentation":"The date and time at which the object is no longer cacheable." + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location", + "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "documentation":"A map of metadata to store with the object in S3.", + "locationName":"x-amz-meta-" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." + } + } + }, + "HeadObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "IfMatch":{ + "shape":"IfMatch", + "location":"header", + "locationName":"If-Match", + "documentation":"Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed)." + }, + "IfModifiedSince":{ + "shape":"IfModifiedSince", + "location":"header", + "locationName":"If-Modified-Since", + "documentation":"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified)." + }, + "IfNoneMatch":{ + "shape":"IfNoneMatch", + "location":"header", + "locationName":"If-None-Match", + "documentation":"Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified)." + }, + "IfUnmodifiedSince":{ + "shape":"IfUnmodifiedSince", + "location":"header", + "locationName":"If-Unmodified-Since", + "documentation":"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed)." + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Range":{ + "shape":"Range", + "location":"header", + "locationName":"Range", + "documentation":"Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId", + "documentation":"VersionId used to reference a specific version of the object." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256)." + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + } + }, + "HostName":{"type":"string"}, + "HttpErrorCodeReturnedEquals":{"type":"string"}, + "HttpRedirectCode":{"type":"string"}, + "ID":{"type":"string"}, + "IfMatch":{"type":"string"}, + "IfModifiedSince":{"type":"timestamp"}, + "IfNoneMatch":{"type":"string"}, + "IfUnmodifiedSince":{"type":"timestamp"}, + "IndexDocument":{ + "type":"structure", + "required":["Suffix"], + "members":{ + "Suffix":{ + "shape":"Suffix", + "documentation":"A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character." + } + } + }, + "Initiated":{"type":"timestamp"}, + "Initiator":{ + "type":"structure", + "members":{ + "ID":{ + "shape":"ID", + "documentation":"If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value." + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"Name of the Principal." + } + } + }, + "IsLatest":{"type":"boolean"}, + "IsTruncated":{"type":"boolean"}, + "KeyMarker":{"type":"string"}, + "KeyPrefixEquals":{"type":"string"}, + "LastModified":{"type":"timestamp"}, + "LifecycleConfiguration":{ + "type":"structure", + "required":["Rules"], + "members":{ + "Rules":{ + "shape":"Rules", + "locationName":"Rule" + } + } + }, + "LifecycleExpiration":{ + "type":"structure", + "members":{ + "Date":{ + "shape":"Date", + "documentation":"Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format." + }, + "Days":{ + "shape":"Days", + "documentation":"Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." + } + } + }, + "ListBucketsOutput":{ + "type":"structure", + "members":{ + "Buckets":{"shape":"Buckets"}, + "Owner":{"shape":"Owner"} + } + }, + "ListMultipartUploadsOutput":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"Name of the bucket to which the multipart upload was initiated." + }, + "KeyMarker":{ + "shape":"KeyMarker", + "documentation":"The key at or after which the listing began." + }, + "UploadIdMarker":{ + "shape":"UploadIdMarker", + "documentation":"Upload ID after which listing began." + }, + "NextKeyMarker":{ + "shape":"NextKeyMarker", + "documentation":"When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request." + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix." + }, + "NextUploadIdMarker":{ + "shape":"NextUploadIdMarker", + "documentation":"When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request." + }, + "MaxUploads":{ + "shape":"MaxUploads", + "documentation":"Maximum number of multipart uploads that could have been included in the response." + }, + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads." + }, + "Uploads":{ + "shape":"MultipartUploadList", + "locationName":"Upload" + }, + "CommonPrefixes":{"shape":"CommonPrefixList"}, + "EncodingType":{ + "shape":"EncodingType", + "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." + } + } + }, + "ListMultipartUploadsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "location":"querystring", + "locationName":"delimiter", + "documentation":"Character you use to group keys." + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "KeyMarker":{ + "shape":"KeyMarker", + "location":"querystring", + "locationName":"key-marker", + "documentation":"Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin." + }, + "MaxUploads":{ + "shape":"MaxUploads", + "location":"querystring", + "locationName":"max-uploads", + "documentation":"Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response." + }, + "Prefix":{ + "shape":"Prefix", + "location":"querystring", + "locationName":"prefix", + "documentation":"Lists in-progress uploads only for those keys that begin with the specified prefix." + }, + "UploadIdMarker":{ + "shape":"UploadIdMarker", + "location":"querystring", + "locationName":"upload-id-marker", + "documentation":"Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored." + } + } + }, + "ListObjectVersionsOutput":{ + "type":"structure", + "members":{ + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results." + }, + "KeyMarker":{ + "shape":"KeyMarker", + "documentation":"Marks the last Key returned in a truncated response." + }, + "VersionIdMarker":{"shape":"VersionIdMarker"}, + "NextKeyMarker":{ + "shape":"NextKeyMarker", + "documentation":"Use this value for the key marker request parameter in a subsequent request." + }, + "NextVersionIdMarker":{ + "shape":"NextVersionIdMarker", + "documentation":"Use this value for the next version id marker parameter in a subsequent request." + }, + "Versions":{ + "shape":"ObjectVersionList", + "locationName":"Version" + }, + "DeleteMarkers":{ + "shape":"DeleteMarkers", + "locationName":"DeleteMarker" + }, + "Name":{"shape":"BucketName"}, + "Prefix":{"shape":"Prefix"}, + "MaxKeys":{"shape":"MaxKeys"}, + "CommonPrefixes":{"shape":"CommonPrefixList"}, + "EncodingType":{ + "shape":"EncodingType", + "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." + } + } + }, + "ListObjectVersionsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "location":"querystring", + "locationName":"delimiter", + "documentation":"A delimiter is a character you use to group keys." + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "KeyMarker":{ + "shape":"KeyMarker", + "location":"querystring", + "locationName":"key-marker", + "documentation":"Specifies the key to start with when listing objects in a bucket." + }, + "MaxKeys":{ + "shape":"MaxKeys", + "location":"querystring", + "locationName":"max-keys", + "documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more." + }, + "Prefix":{ + "shape":"Prefix", + "location":"querystring", + "locationName":"prefix", + "documentation":"Limits the response to keys that begin with the specified prefix." + }, + "VersionIdMarker":{ + "shape":"VersionIdMarker", + "location":"querystring", + "locationName":"version-id-marker", + "documentation":"Specifies the object version you want to start listing from." + } + } + }, + "ListObjectsOutput":{ + "type":"structure", + "members":{ + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria." + }, + "Marker":{"shape":"Marker"}, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys." + }, + "Contents":{"shape":"ObjectList"}, + "Name":{"shape":"BucketName"}, + "Prefix":{"shape":"Prefix"}, + "MaxKeys":{"shape":"MaxKeys"}, + "CommonPrefixes":{"shape":"CommonPrefixList"}, + "EncodingType":{ + "shape":"EncodingType", + "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." + } + } + }, + "ListObjectsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "location":"querystring", + "locationName":"delimiter", + "documentation":"A delimiter is a character you use to group keys." + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "Marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker", + "documentation":"Specifies the key to start with when listing objects in a bucket." + }, + "MaxKeys":{ + "shape":"MaxKeys", + "location":"querystring", + "locationName":"max-keys", + "documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more." + }, + "Prefix":{ + "shape":"Prefix", + "location":"querystring", + "locationName":"prefix", + "documentation":"Limits the response to keys that begin with the specified prefix." + } + } + }, + "ListPartsOutput":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"Name of the bucket to which the multipart upload was initiated." + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"Object key for which the multipart upload was initiated." + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"Upload ID identifying the multipart upload whose parts are being listed." + }, + "PartNumberMarker":{ + "shape":"PartNumberMarker", + "documentation":"Part number after which listing begins." + }, + "NextPartNumberMarker":{ + "shape":"NextPartNumberMarker", + "documentation":"When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request." + }, + "MaxParts":{ + "shape":"MaxParts", + "documentation":"Maximum number of parts that were allowed in the response." + }, + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"Indicates whether the returned list of parts is truncated." + }, + "Parts":{ + "shape":"Parts", + "locationName":"Part" + }, + "Initiator":{ + "shape":"Initiator", + "documentation":"Identifies who initiated the multipart upload." + }, + "Owner":{"shape":"Owner"}, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"The class of storage used to store the object." + } + } + }, + "ListPartsRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "MaxParts":{ + "shape":"MaxParts", + "location":"querystring", + "locationName":"max-parts", + "documentation":"Sets the maximum number of parts to return." + }, + "PartNumberMarker":{ + "shape":"PartNumberMarker", + "location":"querystring", + "locationName":"part-number-marker", + "documentation":"Specifies the part after which listing should begin. Only parts with higher part numbers will be listed." + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId", + "documentation":"Upload ID identifying the multipart upload whose parts are being listed." + } + } + }, + "Location":{"type":"string"}, + "LoggingEnabled":{ + "type":"structure", + "members":{ + "TargetBucket":{ + "shape":"TargetBucket", + "documentation":"Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key." + }, + "TargetGrants":{"shape":"TargetGrants"}, + "TargetPrefix":{ + "shape":"TargetPrefix", + "documentation":"This element lets you specify a prefix for the keys that the log files will be stored under." + } + } + }, + "MFA":{"type":"string"}, + "MFADelete":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "MFADeleteStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "Marker":{"type":"string"}, + "MaxAgeSeconds":{"type":"integer"}, + "MaxKeys":{"type":"integer"}, + "MaxParts":{"type":"integer"}, + "MaxUploads":{"type":"integer"}, + "Message":{"type":"string"}, + "Metadata":{ + "type":"map", + "key":{"shape":"MetadataKey"}, + "value":{"shape":"MetadataValue"} + }, + "MetadataDirective":{ + "type":"string", + "enum":[ + "COPY", + "REPLACE" + ] + }, + "MetadataKey":{"type":"string"}, + "MetadataValue":{"type":"string"}, + "MissingMeta":{"type":"integer"}, + "MultipartUpload":{ + "type":"structure", + "members":{ + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"Upload ID that identifies the multipart upload." + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"Key of the object for which the multipart upload was initiated." + }, + "Initiated":{ + "shape":"Initiated", + "documentation":"Date and time at which the multipart upload was initiated." + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"The class of storage used to store the object." + }, + "Owner":{"shape":"Owner"}, + "Initiator":{ + "shape":"Initiator", + "documentation":"Identifies who initiated the multipart upload." + } + } + }, + "MultipartUploadId":{"type":"string"}, + "MultipartUploadList":{ + "type":"list", + "member":{"shape":"MultipartUpload"}, + "flattened":true + }, + "NextKeyMarker":{"type":"string"}, + "NextMarker":{"type":"string"}, + "NextPartNumberMarker":{"type":"integer"}, + "NextUploadIdMarker":{"type":"string"}, + "NextVersionIdMarker":{"type":"string"}, + "NoSuchBucket":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"The specified bucket does not exist." + }, + "NoSuchKey":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"The specified key does not exist." + }, + "NoSuchUpload":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"The specified multipart upload does not exist." + }, + "NoncurrentVersionExpiration":{ + "type":"structure", + "members":{ + "NoncurrentDays":{ + "shape":"Days", + "documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide." + } + }, + "documentation":"Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions.\n\nYou set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime." + }, + "NoncurrentVersionTransition":{ + "type":"structure", + "members":{ + "NoncurrentDays":{ + "shape":"Days", + "documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide." + }, + "StorageClass":{ + "shape":"TransitionStorageClass", + "documentation":"The class of storage used to store the object." + } + }, + "documentation":"Container for the transition rule that describes when noncurrent objects transition to the GLACIER storage class.\n\nIf your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the GLACIER storage class at a specific period in the object's lifetime." + }, + "NotificationConfiguration":{ + "type":"structure", + "required":["TopicConfiguration"], + "members":{ + "TopicConfiguration":{"shape":"TopicConfiguration"} + } + }, + "Object":{ + "type":"structure", + "members":{ + "Key":{"shape":"ObjectKey"}, + "LastModified":{"shape":"LastModified"}, + "ETag":{"shape":"ETag"}, + "Size":{"shape":"Size"}, + "StorageClass":{ + "shape":"ObjectStorageClass", + "documentation":"The class of storage used to store the object." + }, + "Owner":{"shape":"Owner"} + } + }, + "ObjectAlreadyInActiveTierError":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"This operation is not allowed against this storage tier" + }, + "ObjectCannedACL":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "authenticated-read", + "bucket-owner-read", + "bucket-owner-full-control" + ] + }, + "ObjectIdentifier":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"Key name of the object to delete." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"VersionId for the specific version of the object to delete." + } + } + }, + "ObjectIdentifierList":{ + "type":"list", + "member":{"shape":"ObjectIdentifier"}, + "flattened":true + }, + "ObjectKey":{"type":"string"}, + "ObjectList":{ + "type":"list", + "member":{"shape":"Object"}, + "flattened":true + }, + "ObjectNotInActiveTierError":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier." + }, + "ObjectStorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "REDUCED_REDUNDANCY", + "GLACIER" + ] + }, + "ObjectVersion":{ + "type":"structure", + "members":{ + "ETag":{"shape":"ETag"}, + "Size":{ + "shape":"Size", + "documentation":"Size in bytes of the object." + }, + "StorageClass":{ + "shape":"ObjectVersionStorageClass", + "documentation":"The class of storage used to store the object." + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"The object key." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"Version ID of an object." + }, + "IsLatest":{ + "shape":"IsLatest", + "documentation":"Specifies whether the object is (true) or is not (false) the latest version of an object." + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"Date and time the object was last modified." + }, + "Owner":{"shape":"Owner"} + } + }, + "ObjectVersionId":{"type":"string"}, + "ObjectVersionList":{ + "type":"list", + "member":{"shape":"ObjectVersion"}, + "flattened":true + }, + "ObjectVersionStorageClass":{ + "type":"string", + "enum":["STANDARD"] + }, + "Owner":{ + "type":"structure", + "members":{ + "DisplayName":{"shape":"DisplayName"}, + "ID":{"shape":"ID"} + } + }, + "Part":{ + "type":"structure", + "members":{ + "PartNumber":{ + "shape":"PartNumber", + "documentation":"Part number identifying the part." + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"Date and time at which the part was uploaded." + }, + "ETag":{ + "shape":"ETag", + "documentation":"Entity tag returned when the part was uploaded." + }, + "Size":{ + "shape":"Size", + "documentation":"Size of the uploaded part data." + } + } + }, + "PartNumber":{"type":"integer"}, + "PartNumberMarker":{"type":"integer"}, + "Parts":{ + "type":"list", + "member":{"shape":"Part"}, + "flattened":true + }, + "Payer":{ + "type":"string", + "enum":[ + "Requester", + "BucketOwner" + ] + }, + "Permission":{ + "type":"string", + "enum":[ + "FULL_CONTROL", + "WRITE", + "WRITE_ACP", + "READ", + "READ_ACP" + ] + }, + "Policy":{"type":"string"}, + "Prefix":{"type":"string"}, + "Protocol":{ + "type":"string", + "enum":[ + "http", + "https" + ] + }, + "PutBucketAclRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "ACL":{ + "shape":"BucketCannedACL", + "location":"header", + "locationName":"x-amz-acl", + "documentation":"The canned ACL to apply to the bucket." + }, + "AccessControlPolicy":{ + "shape":"AccessControlPolicy", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"AccessControlPolicy" + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control", + "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read", + "documentation":"Allows grantee to list the objects in the bucket." + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp", + "documentation":"Allows grantee to read the bucket ACL." + }, + "GrantWrite":{ + "shape":"GrantWrite", + "location":"header", + "locationName":"x-amz-grant-write", + "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket." + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp", + "documentation":"Allows grantee to write the ACL for the applicable bucket." + } + }, + "payload":"AccessControlPolicy" + }, + "PutBucketCorsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CORSConfiguration":{ + "shape":"CORSConfiguration", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"CORSConfiguration" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"CORSConfiguration" + }, + "PutBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "LifecycleConfiguration":{ + "shape":"LifecycleConfiguration", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"LifecycleConfiguration" + } + }, + "payload":"LifecycleConfiguration" + }, + "PutBucketLoggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "BucketLoggingStatus" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "BucketLoggingStatus":{ + "shape":"BucketLoggingStatus", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"BucketLoggingStatus" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"BucketLoggingStatus" + }, + "PutBucketNotificationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "NotificationConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "NotificationConfiguration":{ + "shape":"NotificationConfiguration", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"NotificationConfiguration" + } + }, + "payload":"NotificationConfiguration" + }, + "PutBucketPolicyRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Policy" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "Policy":{ + "shape":"Policy", + "documentation":"The bucket policy as a JSON document." + } + }, + "payload":"Policy" + }, + "PutBucketRequestPaymentRequest":{ + "type":"structure", + "required":[ + "Bucket", + "RequestPaymentConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "RequestPaymentConfiguration":{ + "shape":"RequestPaymentConfiguration", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"RequestPaymentConfiguration" + } + }, + "payload":"RequestPaymentConfiguration" + }, + "PutBucketTaggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Tagging" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "Tagging":{ + "shape":"Tagging", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"Tagging" + } + }, + "payload":"Tagging" + }, + "PutBucketVersioningRequest":{ + "type":"structure", + "required":[ + "Bucket", + "VersioningConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "MFA":{ + "shape":"MFA", + "location":"header", + "locationName":"x-amz-mfa", + "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." + }, + "VersioningConfiguration":{ + "shape":"VersioningConfiguration", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"VersioningConfiguration" + } + }, + "payload":"VersioningConfiguration" + }, + "PutBucketWebsiteRequest":{ + "type":"structure", + "required":[ + "Bucket", + "WebsiteConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "WebsiteConfiguration":{ + "shape":"WebsiteConfiguration", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"WebsiteConfiguration" + } + }, + "payload":"WebsiteConfiguration" + }, + "PutObjectAclRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "location":"header", + "locationName":"x-amz-acl", + "documentation":"The canned ACL to apply to the object." + }, + "AccessControlPolicy":{ + "shape":"AccessControlPolicy", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"AccessControlPolicy" + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control", + "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read", + "documentation":"Allows grantee to list the objects in the bucket." + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp", + "documentation":"Allows grantee to read the bucket ACL." + }, + "GrantWrite":{ + "shape":"GrantWrite", + "location":"header", + "locationName":"x-amz-grant-write", + "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket." + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp", + "documentation":"Allows grantee to write the ACL for the applicable bucket." + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + } + }, + "payload":"AccessControlPolicy" + }, + "PutObjectOutput":{ + "type":"structure", + "members":{ + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration", + "documentation":"If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded." + }, + "ETag":{ + "shape":"ETag", + "location":"header", + "locationName":"ETag", + "documentation":"Entity tag for the uploaded object." + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id", + "documentation":"Version of the object." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." + } + } + }, + "PutObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "location":"header", + "locationName":"x-amz-acl", + "documentation":"The canned ACL to apply to the object." + }, + "Body":{ + "shape":"Body", + "streaming":true + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control", + "documentation":"Specifies caching behavior along the request/reply chain." + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition", + "documentation":"Specifies presentational information for the object." + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding", + "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language", + "documentation":"The language the content is in." + }, + "ContentLength":{ + "shape":"ContentLength", + "location":"header", + "locationName":"Content-Length", + "documentation":"Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically." + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type", + "documentation":"A standard MIME type describing the format of the object data." + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires", + "documentation":"The date and time at which the object is no longer cacheable." + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control", + "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read", + "documentation":"Allows grantee to read the object data and its metadata." + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp", + "documentation":"Allows grantee to read the object ACL." + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp", + "documentation":"Allows grantee to write the ACL for the applicable object." + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "documentation":"A map of metadata to store with the object in S3.", + "locationName":"x-amz-meta-" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "StorageClass":{ + "shape":"StorageClass", + "location":"header", + "locationName":"x-amz-storage-class", + "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'." + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location", + "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256)." + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + }, + "payload":"Body" + }, + "Quiet":{"type":"boolean"}, + "Range":{"type":"string"}, + "Redirect":{ + "type":"structure", + "members":{ + "HostName":{ + "shape":"HostName", + "documentation":"The host name to use in the redirect request." + }, + "HttpRedirectCode":{ + "shape":"HttpRedirectCode", + "documentation":"The HTTP redirect code to use on the response. Not required if one of the siblings is present." + }, + "Protocol":{ + "shape":"Protocol", + "documentation":"Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." + }, + "ReplaceKeyPrefixWith":{ + "shape":"ReplaceKeyPrefixWith", + "documentation":"The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided." + }, + "ReplaceKeyWith":{ + "shape":"ReplaceKeyWith", + "documentation":"The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided." + } + } + }, + "RedirectAllRequestsTo":{ + "type":"structure", + "required":["HostName"], + "members":{ + "HostName":{ + "shape":"HostName", + "documentation":"Name of the host where requests will be redirected." + }, + "Protocol":{ + "shape":"Protocol", + "documentation":"Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." + } + } + }, + "ReplaceKeyPrefixWith":{"type":"string"}, + "ReplaceKeyWith":{"type":"string"}, + "RequestPaymentConfiguration":{ + "type":"structure", + "required":["Payer"], + "members":{ + "Payer":{ + "shape":"Payer", + "documentation":"Specifies who pays for the download and request fees." + } + } + }, + "ResponseCacheControl":{"type":"string"}, + "ResponseContentDisposition":{"type":"string"}, + "ResponseContentEncoding":{"type":"string"}, + "ResponseContentLanguage":{"type":"string"}, + "ResponseContentType":{"type":"string"}, + "ResponseExpires":{"type":"timestamp"}, + "Restore":{"type":"string"}, + "RestoreObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId" + }, + "RestoreRequest":{ + "shape":"RestoreRequest", + "xmlNamespace":"http://s3.amazonaws.com/doc/2006-03-01/", + "locationName":"RestoreRequest" + } + }, + "payload":"RestoreRequest" + }, + "RestoreRequest":{ + "type":"structure", + "required":["Days"], + "members":{ + "Days":{ + "shape":"Days", + "documentation":"Lifetime of the active copy in days" + } + } + }, + "RoutingRule":{ + "type":"structure", + "required":["Redirect"], + "members":{ + "Condition":{ + "shape":"Condition", + "documentation":"A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." + }, + "Redirect":{ + "shape":"Redirect", + "documentation":"Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return." + } + } + }, + "RoutingRules":{ + "type":"list", + "member":{ + "shape":"RoutingRule", + "locationName":"RoutingRule" + } + }, + "Rule":{ + "type":"structure", + "required":[ + "Prefix", + "Status" + ], + "members":{ + "Expiration":{"shape":"LifecycleExpiration"}, + "ID":{ + "shape":"ID", + "documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters." + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"Prefix identifying one or more objects to which the rule applies." + }, + "Status":{ + "shape":"ExpirationStatus", + "documentation":"If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied." + }, + "Transition":{"shape":"Transition"}, + "NoncurrentVersionTransition":{"shape":"NoncurrentVersionTransition"}, + "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"} + } + }, + "Rules":{ + "type":"list", + "member":{"shape":"Rule"}, + "flattened":true + }, + "SSECustomerAlgorithm":{"type":"string"}, + "SSECustomerKey":{"type":"string"}, + "SSECustomerKeyMD5":{"type":"string"}, + "ServerSideEncryption":{ + "type":"string", + "enum":["AES256"] + }, + "Size":{"type":"integer"}, + "StorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "REDUCED_REDUNDANCY" + ] + }, + "Suffix":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"Name of the tag." + }, + "Value":{ + "shape":"Value", + "documentation":"Value of the tag." + } + } + }, + "TagSet":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "Tagging":{ + "type":"structure", + "required":["TagSet"], + "members":{ + "TagSet":{"shape":"TagSet"} + } + }, + "TargetBucket":{"type":"string"}, + "TargetGrant":{ + "type":"structure", + "members":{ + "Grantee":{"shape":"Grantee"}, + "Permission":{ + "shape":"BucketLogsPermission", + "documentation":"Logging permissions assigned to the Grantee for the bucket." + } + } + }, + "TargetGrants":{ + "type":"list", + "member":{ + "shape":"TargetGrant", + "locationName":"Grant" + } + }, + "TargetPrefix":{"type":"string"}, + "Topic":{"type":"string"}, + "TopicConfiguration":{ + "type":"structure", + "members":{ + "Event":{ + "shape":"Event", + "documentation":"Bucket event for which to send notifications." + }, + "Topic":{ + "shape":"Topic", + "documentation":"Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket." + } + } + }, + "Transition":{ + "type":"structure", + "members":{ + "Date":{ + "shape":"Date", + "documentation":"Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format." + }, + "Days":{ + "shape":"Days", + "documentation":"Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." + }, + "StorageClass":{ + "shape":"TransitionStorageClass", + "documentation":"The class of storage used to store the object." + } + } + }, + "TransitionStorageClass":{ + "type":"string", + "enum":["GLACIER"] + }, + "Type":{ + "type":"string", + "enum":[ + "CanonicalUser", + "AmazonCustomerByEmail", + "Group" + ], + "xmlAttribute":true, + "locationName":"xsi:type" + }, + "URI":{"type":"string"}, + "UploadIdMarker":{"type":"string"}, + "UploadPartCopyOutput":{ + "type":"structure", + "members":{ + "CopySourceVersionId":{ + "shape":"CopySourceVersionId", + "location":"header", + "locationName":"x-amz-copy-source-version-id", + "documentation":"The version of the source object that was copied, if you have enabled versioning on the source bucket." + }, + "CopyPartResult":{"shape":"CopyPartResult"}, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." + } + }, + "payload":"CopyPartResult" + }, + "UploadPartCopyRequest":{ + "type":"structure", + "required":[ + "Bucket", + "CopySource", + "Key", + "PartNumber", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CopySource":{ + "shape":"CopySource", + "location":"header", + "locationName":"x-amz-copy-source", + "documentation":"The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded." + }, + "CopySourceIfMatch":{ + "shape":"CopySourceIfMatch", + "location":"header", + "locationName":"x-amz-copy-source-if-match", + "documentation":"Copies the object if its entity tag (ETag) matches the specified tag." + }, + "CopySourceIfModifiedSince":{ + "shape":"CopySourceIfModifiedSince", + "location":"header", + "locationName":"x-amz-copy-source-if-modified-since", + "documentation":"Copies the object if it has been modified since the specified time." + }, + "CopySourceIfNoneMatch":{ + "shape":"CopySourceIfNoneMatch", + "location":"header", + "locationName":"x-amz-copy-source-if-none-match", + "documentation":"Copies the object if its entity tag (ETag) is different than the specified ETag." + }, + "CopySourceIfUnmodifiedSince":{ + "shape":"CopySourceIfUnmodifiedSince", + "location":"header", + "locationName":"x-amz-copy-source-if-unmodified-since", + "documentation":"Copies the object if it hasn't been modified since the specified time." + }, + "CopySourceRange":{ + "shape":"CopySourceRange", + "location":"header", + "locationName":"x-amz-copy-source-range", + "documentation":"The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB." + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "PartNumber":{ + "shape":"PartNumber", + "location":"querystring", + "locationName":"partNumber", + "documentation":"Part number of part being copied." + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId", + "documentation":"Upload ID identifying the multipart upload whose part is being copied." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256)." + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + }, + "CopySourceSSECustomerAlgorithm":{ + "shape":"CopySourceSSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use when decrypting the source object (e.g., AES256)." + }, + "CopySourceSSECustomerKey":{ + "shape":"CopySourceSSECustomerKey", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created." + }, + "CopySourceSSECustomerKeyMD5":{ + "shape":"CopySourceSSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + } + }, + "UploadPartOutput":{ + "type":"structure", + "members":{ + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption", + "documentation":"The Server-side encryption algorithm used when storing this object in S3." + }, + "ETag":{ + "shape":"ETag", + "location":"header", + "locationName":"ETag", + "documentation":"Entity tag for the uploaded object." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." + } + } + }, + "UploadPartRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "PartNumber", + "UploadId" + ], + "members":{ + "Body":{ + "shape":"Body", + "streaming":true + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentLength":{ + "shape":"ContentLength", + "location":"header", + "locationName":"Content-Length", + "documentation":"Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically." + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "PartNumber":{ + "shape":"PartNumber", + "location":"querystring", + "locationName":"partNumber", + "documentation":"Part number of part being uploaded." + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId", + "documentation":"Upload ID identifying the multipart upload whose part is being uploaded." + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm", + "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256)." + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key", + "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request." + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5", + "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + }, + "payload":"Body" + }, + "Value":{"type":"string"}, + "VersionIdMarker":{"type":"string"}, + "VersioningConfiguration":{ + "type":"structure", + "members":{ + "MFADelete":{ + "shape":"MFADelete", + "documentation":"Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.", + "locationName":"MfaDelete" + }, + "Status":{ + "shape":"BucketVersioningStatus", + "documentation":"The versioning state of the bucket." + } + } + }, + "WebsiteConfiguration":{ + "type":"structure", + "members":{ + "ErrorDocument":{"shape":"ErrorDocument"}, + "IndexDocument":{"shape":"IndexDocument"}, + "RedirectAllRequestsTo":{"shape":"RedirectAllRequestsTo"}, + "RoutingRules":{"shape":"RoutingRules"} + } + }, + "WebsiteRedirectLocation":{"type":"string"} + } +} diff --git a/apis/s3-2006-03-01.paginators.json b/apis/s3-2006-03-01.paginators.json new file mode 100644 index 0000000000..725c432a16 --- /dev/null +++ b/apis/s3-2006-03-01.paginators.json @@ -0,0 +1,57 @@ +{ + "pagination": { + "ListBuckets": { + "result_key": "Buckets" + }, + "ListMultipartUploads": { + "limit_key": "MaxUploads", + "more_results": "IsTruncated", + "output_token": [ + "NextKeyMarker", + "NextUploadIdMarker" + ], + "input_token": [ + "KeyMarker", + "UploadIdMarker" + ], + "result_key": [ + "Uploads", + "CommonPrefixes" + ] + }, + "ListObjectVersions": { + "more_results": "IsTruncated", + "limit_key": "MaxKeys", + "output_token": [ + "NextKeyMarker", + "NextVersionIdMarker" + ], + "input_token": [ + "KeyMarker", + "VersionIdMarker" + ], + "result_key": [ + "Versions", + "DeleteMarkers", + "CommonPrefixes" + ] + }, + "ListObjects": { + "more_results": "IsTruncated", + "limit_key": "MaxKeys", + "output_token": "NextMarker or Contents[-1].Key", + "input_token": "Marker", + "result_key": [ + "Contents", + "CommonPrefixes" + ] + }, + "ListParts": { + "more_results": "IsTruncated", + "limit_key": "MaxParts", + "output_token": "NextPartNumberMarker", + "input_token": "PartNumberMarker", + "result_key": "Parts" + } + } +} diff --git a/apis/s3-2006-03-01.waiters.json b/apis/s3-2006-03-01.waiters.json new file mode 100644 index 0000000000..963e5bf9e2 --- /dev/null +++ b/apis/s3-2006-03-01.waiters.json @@ -0,0 +1,32 @@ +{ + "waiters": { + "__default__": { + "interval": 5, + "max_attempts": 20 + }, + "BucketExists": { + "operation": "HeadBucket", + "ignore_errors": [ + 404 + ], + "success_type": "output" + }, + "BucketNotExists": { + "operation": "HeadBucket", + "success_type": "error", + "success_value": 404 + }, + "ObjectExists": { + "operation": "HeadObject", + "ignore_errors": [ + 404 + ], + "success_type": "output" + }, + "ObjectNotExists": { + "operation": "HeadObject", + "success_type": "error", + "success_value": 404 + } + } +} diff --git a/apis/sdb-2009-04-15.api.json b/apis/sdb-2009-04-15.api.json new file mode 100644 index 0000000000..e931b3cf36 --- /dev/null +++ b/apis/sdb-2009-04-15.api.json @@ -0,0 +1,336 @@ +{ + "metadata": { + "apiVersion": "2009-04-15", + "endpointPrefix": "sdb", + "serviceFullName": "Amazon SimpleDB", + "signatureVersion": "v2", + "xmlNamespace": "http://sdb.amazonaws.com/doc/2009-04-15/", + "protocol": "query" + }, + "operations": { + "BatchDeleteAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Items" + ], + "members": { + "DomainName": {}, + "Items": { + "type": "list", + "member": { + "locationName": "Item", + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": { + "locationName": "ItemName" + }, + "Attributes": { + "shape": "S5" + } + } + }, + "flattened": true + } + } + } + }, + "BatchPutAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "Items" + ], + "members": { + "DomainName": {}, + "Items": { + "type": "list", + "member": { + "locationName": "Item", + "type": "structure", + "required": [ + "Name", + "Attributes" + ], + "members": { + "Name": { + "locationName": "ItemName" + }, + "Attributes": { + "shape": "Sa" + } + } + }, + "flattened": true + } + } + } + }, + "CreateDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + } + }, + "DeleteAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ItemName" + ], + "members": { + "DomainName": {}, + "ItemName": {}, + "Attributes": { + "shape": "S5" + }, + "Expected": { + "shape": "Sf" + } + } + } + }, + "DeleteDomain": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + } + }, + "DomainMetadata": { + "input": { + "type": "structure", + "required": [ + "DomainName" + ], + "members": { + "DomainName": {} + } + }, + "output": { + "resultWrapper": "DomainMetadataResult", + "type": "structure", + "members": { + "ItemCount": { + "type": "integer" + }, + "ItemNamesSizeBytes": { + "type": "long" + }, + "AttributeNameCount": { + "type": "integer" + }, + "AttributeNamesSizeBytes": { + "type": "long" + }, + "AttributeValueCount": { + "type": "integer" + }, + "AttributeValuesSizeBytes": { + "type": "long" + }, + "Timestamp": { + "type": "integer" + } + } + } + }, + "GetAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ItemName" + ], + "members": { + "DomainName": {}, + "ItemName": {}, + "AttributeNames": { + "type": "list", + "member": { + "locationName": "AttributeName" + }, + "flattened": true + }, + "ConsistentRead": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "GetAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "So" + } + } + } + }, + "ListDomains": { + "input": { + "type": "structure", + "members": { + "MaxNumberOfDomains": { + "type": "integer" + }, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListDomainsResult", + "type": "structure", + "members": { + "DomainNames": { + "type": "list", + "member": { + "locationName": "DomainName" + }, + "flattened": true + }, + "NextToken": {} + } + } + }, + "PutAttributes": { + "input": { + "type": "structure", + "required": [ + "DomainName", + "ItemName", + "Attributes" + ], + "members": { + "DomainName": {}, + "ItemName": {}, + "Attributes": { + "shape": "Sa" + }, + "Expected": { + "shape": "Sf" + } + } + } + }, + "Select": { + "input": { + "type": "structure", + "required": [ + "SelectExpression" + ], + "members": { + "SelectExpression": {}, + "NextToken": {}, + "ConsistentRead": { + "type": "boolean" + } + } + }, + "output": { + "resultWrapper": "SelectResult", + "type": "structure", + "members": { + "Items": { + "type": "list", + "member": { + "locationName": "Item", + "type": "structure", + "required": [ + "Name", + "Attributes" + ], + "members": { + "Name": {}, + "AlternateNameEncoding": {}, + "Attributes": { + "shape": "So" + } + } + }, + "flattened": true + }, + "NextToken": {} + } + } + } + }, + "shapes": { + "S5": { + "type": "list", + "member": { + "locationName": "Attribute", + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Value": {} + } + }, + "flattened": true + }, + "Sa": { + "type": "list", + "member": { + "locationName": "Attribute", + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "Value": {}, + "Replace": { + "type": "boolean" + } + } + }, + "flattened": true + }, + "Sf": { + "type": "structure", + "members": { + "Name": {}, + "Value": {}, + "Exists": { + "type": "boolean" + } + } + }, + "So": { + "type": "list", + "member": { + "locationName": "Attribute", + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": {}, + "AlternateNameEncoding": {}, + "Value": {}, + "AlternateValueEncoding": {} + } + }, + "flattened": true + } + } +} \ No newline at end of file diff --git a/apis/sdb-2009-04-15.full.json b/apis/sdb-2009-04-15.full.json new file mode 100644 index 0000000000..deed8af8a1 --- /dev/null +++ b/apis/sdb-2009-04-15.full.json @@ -0,0 +1,1203 @@ +{ + "metadata":{ + "apiVersion":"2009-04-15", + "endpointPrefix":"sdb", + "serviceFullName":"Amazon SimpleDB", + "signatureVersion":"v2", + "xmlNamespace":"http://sdb.amazonaws.com/doc/2009-04-15/", + "protocol":"query" + }, + "documentation":"Amazon SimpleDB is a web service providing the core database functions of\n data indexing and querying in the cloud. By offloading the time and effort associated with\n building and operating a web-scale database, SimpleDB provides developers the freedom to focus\n on application development.\n\n

\n A traditional, clustered relational database requires a sizable upfront capital outlay,\n is complex to design, and often requires extensive and repetitive database administration.\n Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data\n and providing a simple API for storage and access. This approach eliminates the administrative\n burden of data modeling, index maintenance, and performance tuning. Developers gain access to\n this functionality within Amazon's proven computing environment, are able to scale instantly,\n and pay only for what they use.\n

\n\n

\n Visit http://aws.amazon.com/simpledb/ for\n more information.\n

", + "operations":{ + "BatchDeleteAttributes":{ + "name":"BatchDeleteAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteAttributesRequest"}, + "documentation":"

\n Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies.\n This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.\n

\n \n

\n If you specify BatchDeleteAttributes without attributes or values,\n all the attributes for the item are deleted.\n

\n

\n BatchDeleteAttributes is an idempotent operation;\n running it multiple times on the same item or attribute doesn't result in an error.\n

\n

\n The BatchDeleteAttributes operation succeeds or fails in its entirety. There are no partial deletes.\n You can execute multiple BatchDeleteAttributes operations and other operations in parallel.\n However, large numbers of concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses.\n

\n

\n This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method.\n

\n

\n This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists.\n

\n \n

\n The following limitations are enforced for this operation:\n

\n

" + }, + "BatchPutAttributes":{ + "name":"BatchPutAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchPutAttributesRequest"}, + "errors":[ + { + "shape":"DuplicateItemName", + "error":{ + "code":"DuplicateItemName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The item name was specified more than once.

" + }, + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified domain does not exist.

" + }, + { + "shape":"NumberItemAttributesExceeded", + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes in this item.

" + }, + { + "shape":"NumberDomainAttributesExceeded", + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes in this domain.

" + }, + { + "shape":"NumberDomainBytesExceeded", + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many bytes in this domain.

" + }, + { + "shape":"NumberSubmittedItemsExceeded", + "error":{ + "code":"NumberSubmittedItemsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many items exist in a single call.

" + }, + { + "shape":"NumberSubmittedAttributesExceeded", + "error":{ + "code":"NumberSubmittedAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes exist in a single call.

" + } + ], + "documentation":"

\n\t The BatchPutAttributes operation creates or replaces attributes within\n\t\tone or more items. By using this operation, the client can perform multiple\n\t\tPutAttribute operation with a single call. This helps yield savings in round trips\n\t\tand latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.\n\t\t

\n\n

\n\t\tThe client may specify the item name with the Item.X.ItemName parameter.\n\t\tThe client may specify new attributes using a combination of the\n\t\tItem.X.Attribute.Y.Name and Item.X.Attribute.Y.Value\n\t\tparameters. The client may specify the first attribute for the first item using the parameters\n\t\tItem.0.Attribute.0.Name and Item.0.Attribute.0.Value,\n\t\tand for the second attribute for the first item by the parameters\n\t\tItem.0.Attribute.1.Name and Item.0.Attribute.1.Value,\n\t\tand so on.\n

\n\n

\n\t\tAttributes are uniquely identified within an item by their name/value\n\t\tcombination. For example, a single item can have the attributes {\n\t\t\"first_name\", \"first_value\" } and { \"first_name\", \"second_value\" }.\n\t\tHowever, it cannot have two attribute instances where both the\n\t\tItem.X.Attribute.Y.Name and Item.X.Attribute.Y.Value\n\t\tare the same.\n

\n\n

\n Optionally, the requester can supply the Replace parameter for each\n\t\tindividual value. Setting this value to true will cause the new\n\t\tattribute values to replace the existing attribute values. For\n\t\texample, if an item I has the attributes { 'a', '1' }, { 'b', '2'}\n\t\tand { 'b', '3' } and the requester does a BatchPutAttributes of {'I',\n\t\t'b', '4' } with the Replace parameter set to true, the final\n\t\tattributes of the item will be { 'a', '1' } and { 'b', '4' },\n\t\treplacing the previous values of the 'b' attribute with the new value.\n

\n\n \n\t\tYou cannot specify an empty string as an item or as an attribute name.\n\t\tThe BatchPutAttributes operation succeeds or fails in its entirety.\n There are no partial puts.\n \n\n \n This operation is vulnerable to exceeding the maximum URL size when making\n a REST request using the HTTP GET method.\n This operation does not support conditions using Expected.X.Name,\n Expected.X.Value, or\n Expected.X.Exists.\n \n\n

\n You can execute multiple BatchPutAttributes operations and other operations in parallel.\n However, large numbers of concurrent BatchPutAttributes calls can result in\n Service Unavailable (503) responses.\n

\n\n

\n The following limitations are enforced for this operation:\n

\n

" + }, + "CreateDomain":{ + "name":"CreateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDomainRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + }, + { + "shape":"NumberDomainsExceeded", + "error":{ + "code":"NumberDomainsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many domains exist per this account.

" + } + ], + "documentation":"

\n\t\tThe CreateDomain operation creates a new domain. The domain name should\n\t\tbe unique among the domains associated with the Access Key ID provided\n\t\tin the request. The CreateDomain operation may take 10 or more seconds to complete.\n\t\t

\n\n \n\t\tCreateDomain is an idempotent operation; running it multiple times using the same\n\t\tdomain name will not result in an error response.\n \n\n

\n The client can create up to 100 domains per account.\n

\n\n

\n If the client requires additional domains, go to\n \n http://aws.amazon.com/contact-us/simpledb-limit-request/.\n

" + }, + "DeleteAttributes":{ + "name":"DeleteAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAttributesRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified domain does not exist.

" + }, + { + "shape":"AttributeDoesNotExist", + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified attribute does not exist.

" + } + ], + "documentation":"

\n Deletes one or more attributes associated with an item.\n If all attributes of the item are deleted, the item is deleted.\n

\n\n \n If DeleteAttributes is called without being passed any attributes or values\n specified, all the attributes for the item are deleted.\n \n\n

\n DeleteAttributes is an idempotent operation; running it multiple\n times on the same item or attribute does not result in an error response.\n

\n\n

\n Because Amazon SimpleDB makes multiple copies of item data and uses an\n eventual consistency update model, performing a GetAttributes or\n Select operation (read) immediately after a DeleteAttributes or\n PutAttributes operation (write) might not return updated item data.\n

" + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDomainRequest"}, + "errors":[ + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + } + ], + "documentation":"

\n\t The DeleteDomain operation deletes a domain. Any items\n\t\t(and their attributes) in the domain are deleted as well.\n\t\tThe DeleteDomain operation might take 10 or more seconds to complete.\n\t\t

\n\n \n Running DeleteDomain on a domain that does not exist or running the\n\t\tfunction multiple times using the same domain name will not result in an error response.\n " + }, + "DomainMetadata":{ + "name":"DomainMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DomainMetadataRequest"}, + "output":{ + "shape":"DomainMetadataResult", + "resultWrapper":"DomainMetadataResult" + }, + "errors":[ + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified domain does not exist.

" + } + ], + "documentation":"

\n\t\tReturns information about the domain, including when the domain was created,\n\t\tthe number of items and attributes in the domain,\n\t\tand the size of the attribute names and values.\n\t\t

" + }, + "GetAttributes":{ + "name":"GetAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAttributesRequest"}, + "output":{ + "shape":"GetAttributesResult", + "resultWrapper":"GetAttributesResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified domain does not exist.

" + } + ], + "documentation":"

\n Returns all of the attributes associated with the specified item.\n Optionally, the attributes returned can be limited to one or\n more attributes by specifying an attribute name parameter.\n

\n\n

\n If the item does not exist on the replica that was accessed\n for this operation, an empty set is returned. The system does\n not return an error as it cannot guarantee the item does\n not exist on other replicas.\n

\n\n \n If GetAttributes is called without being passed any attribute names, all\n the attributes for the item are returned.\n " + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{ + "shape":"ListDomainsResult", + "resultWrapper":"ListDomainsResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified NextToken is not valid.

" + } + ], + "documentation":"

\n The ListDomains operation lists all domains associated with the\n Access Key ID. It returns domain names up to the limit set by\n MaxNumberOfDomains.\n A NextToken is returned if there are more\n \tthan MaxNumberOfDomains domains. Calling ListDomains successive\n times with the NextToken provided by the operation\n returns up to MaxNumberOfDomains more domain names\n with each successive operation call.\n

" + }, + "PutAttributes":{ + "name":"PutAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAttributesRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified domain does not exist.

" + }, + { + "shape":"NumberDomainAttributesExceeded", + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes in this domain.

" + }, + { + "shape":"NumberDomainBytesExceeded", + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many bytes in this domain.

" + }, + { + "shape":"NumberItemAttributesExceeded", + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes in this item.

" + }, + { + "shape":"AttributeDoesNotExist", + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified attribute does not exist.

" + } + ], + "documentation":"

\n\t\tThe PutAttributes operation creates or replaces attributes\n\t\tin an item. The client may specify new attributes using a combination\n\t\tof the Attribute.X.Name and Attribute.X.Value\n\t\tparameters. The client specifies the first attribute by the parameters\n\t\tAttribute.0.Name and Attribute.0.Value,\n\t\tthe second attribute by the parameters Attribute.1.Name\n\t\tand Attribute.1.Value, and so on.\n\t\t

\n\n

\n\t\tAttributes are uniquely identified in an item by their name/value\n\t\tcombination. For example, a single item can have the attributes\n\t\t{ \"first_name\", \"first_value\" } and { \"first_name\",\n\t\tsecond_value\" }. However, it cannot have two attribute instances\n\t\twhere both the Attribute.X.Name and Attribute.X.Value\n\t\tare the same.\n

\n\n

\n Optionally, the requestor can supply the Replace parameter for each\n\t\tindividual attribute. Setting this value to true causes the new\n\t\tattribute value to replace the existing attribute value(s).\n\t\tFor example, if an item has the attributes { 'a', '1' },\n\t\t{ 'b', '2'} and { 'b', '3' } and the requestor\n calls PutAttributes using the attributes { 'b', '4' } with\n the Replace parameter set to true, the final attributes of the item are changed\n\t\tto { 'a', '1' } and { 'b', '4' }, which replaces the\n\t\tprevious values of the 'b' attribute with the new value.\n

\n\n \n Using PutAttributes to replace attribute values that do not exist will not\n\t\tresult in an error response.\n \n\n

\n You cannot specify an empty string as an attribute name.\n

\n\n

\n Because Amazon SimpleDB makes multiple copies of client data and uses\n an eventual consistency update model, an immediate GetAttributes\n or Select operation (read) immediately after a PutAttributes or\n DeleteAttributes operation (write) might not return the updated data.\n

\n\n

\n The following limitations are enforced for this operation:\n\n

\n

" + }, + "Select":{ + "name":"Select", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SelectRequest"}, + "output":{ + "shape":"SelectResult", + "resultWrapper":"SelectResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified NextToken is not valid.

" + }, + { + "shape":"InvalidNumberPredicates", + "error":{ + "code":"InvalidNumberPredicates", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many predicates exist in the query expression.

" + }, + { + "shape":"InvalidNumberValueTests", + "error":{ + "code":"InvalidNumberValueTests", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many predicates exist in the query expression.

" + }, + { + "shape":"InvalidQueryExpression", + "error":{ + "code":"InvalidQueryExpression", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified query expression syntax is not valid.

" + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified domain does not exist.

" + }, + { + "shape":"RequestTimeout", + "error":{ + "code":"RequestTimeout", + "httpStatusCode":408, + "senderFault":true + }, + "exception":true, + "documentation":"

A timeout occurred when attempting to\n query the specified domain with specified query expression.

" + }, + { + "shape":"TooManyRequestedAttributes", + "error":{ + "code":"TooManyRequestedAttributes", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes requested.

" + } + ], + "documentation":"

\n The Select operation returns a set of attributes for ItemNames\n that match the select expression. Select is similar to the standard\n SQL SELECT statement.\n

\n\n

\n The total size of the response cannot exceed 1 MB in total size.\n Amazon SimpleDB automatically adjusts the number of items\n returned per page to enforce this limit. For example, if the client asks\n to retrieve 2500 items, but each individual item\n is 10 kB in size, the system returns 100 items and an\n appropriate NextToken so the client can access the next page of results.\n

\n\n

\n For information on how to construct select expressions,\n see Using Select to Create Amazon SimpleDB Queries in the\n Developer Guide.\n

" + } + }, + "shapes":{ + "Attribute":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the attribute." + }, + "AlternateNameEncoding":{ + "shape":"String", + "documentation":"

" + }, + "Value":{ + "shape":"String", + "documentation":"The value of the attribute." + }, + "AlternateValueEncoding":{ + "shape":"String", + "documentation":"

" + } + }, + "documentation":"

" + }, + "AttributeDoesNotExist":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified attribute does not exist.

" + }, + "AttributeList":{ + "type":"list", + "member":{ + "shape":"Attribute", + "locationName":"Attribute" + }, + "flattened":true + }, + "AttributeNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AttributeName" + }, + "flattened":true + }, + "BatchDeleteAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Items" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which the attributes are being deleted." + }, + "Items":{ + "shape":"DeletableItemList", + "documentation":"A list of items on which to perform the operation." + } + } + }, + "BatchPutAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Items" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which the attributes are being stored." + }, + "Items":{ + "shape":"ReplaceableItemList", + "documentation":"A list of items on which to perform the operation." + } + } + }, + "Boolean":{"type":"boolean"}, + "CreateDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain to create. The name can range between 3 and 255\n\t\tcharacters and can contain the following characters: a-z, A-Z, 0-9,\n\t\t'_', '-', and '.'." + } + } + }, + "DeletableAttribute":{ + "type":"structure", + "required":[ + "Name" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the attribute." + }, + "Value":{ + "shape":"String", + "documentation":"The value of the attribute." + } + }, + "documentation":"

" + }, + "DeletableAttributeList":{ + "type":"list", + "member":{ + "shape":"DeletableAttribute", + "locationName":"Attribute" + }, + "flattened":true + }, + "DeletableItem":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "locationName":"ItemName" + }, + "Attributes":{"shape":"DeletableAttributeList"} + } + }, + "DeletableItemList":{ + "type":"list", + "member":{ + "shape":"DeletableItem", + "locationName":"Item" + }, + "flattened":true + }, + "DeleteAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which to perform the operation." + }, + "ItemName":{ + "shape":"String", + "documentation":"The name of the item. Similar to rows on a spreadsheet,\n items represent individual objects that contain one or more\n value-attribute pairs." + }, + "Attributes":{ + "shape":"DeletableAttributeList", + "documentation":"A list of Attributes. Similar to columns on a spreadsheet, attributes\n represent categories of data that can be assigned to items." + }, + "Expected":{ + "shape":"UpdateCondition", + "documentation":"The update condition which, if specified, determines whether the specified attributes\n will be deleted or not. The update condition must be satisfied in order for this\n request to be processed and the attributes to be deleted." + } + } + }, + "DeleteDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain to delete." + } + } + }, + "DomainMetadataRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain for which to display the metadata of." + } + } + }, + "DomainMetadataResult":{ + "type":"structure", + "members":{ + "ItemCount":{ + "shape":"Integer", + "documentation":"The number of all items in the domain." + }, + "ItemNamesSizeBytes":{ + "shape":"Long", + "documentation":"The total size of all item names in the domain, in bytes." + }, + "AttributeNameCount":{ + "shape":"Integer", + "documentation":"The number of unique attribute names in the domain." + }, + "AttributeNamesSizeBytes":{ + "shape":"Long", + "documentation":"The total size of all unique attribute names in the domain, in bytes." + }, + "AttributeValueCount":{ + "shape":"Integer", + "documentation":"The number of all attribute name/value pairs in the domain." + }, + "AttributeValuesSizeBytes":{ + "shape":"Long", + "documentation":"The total size of all attribute values in the domain, in bytes." + }, + "Timestamp":{ + "shape":"Integer", + "documentation":"The data and time when metadata was calculated, in Epoch (UNIX) seconds." + } + } + }, + "DomainNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DomainName" + }, + "flattened":true + }, + "DuplicateItemName":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"DuplicateItemName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The item name was specified more than once.

" + }, + "Float":{"type":"float"}, + "GetAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which to perform the operation." + }, + "ItemName":{ + "shape":"String", + "documentation":"The name of the item." + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"The names of the attributes." + }, + "ConsistentRead":{ + "shape":"Boolean", + "documentation":"Determines whether or not strong consistency should be enforced when data is read\n from SimpleDB. If true, any data previously written to SimpleDB\n will be returned. Otherwise, results will be consistent eventually, and the client\n may not see data that was written immediately before your read." + } + } + }, + "GetAttributesResult":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeList", + "documentation":"The list of attributes returned by the operation." + } + } + }, + "Integer":{"type":"integer"}, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified NextToken is not valid.

" + }, + "InvalidNumberPredicates":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNumberPredicates", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many predicates exist in the query expression.

" + }, + "InvalidNumberValueTests":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNumberValueTests", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many predicates exist in the query expression.

" + }, + "InvalidParameterValue":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + "InvalidQueryExpression":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidQueryExpression", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified query expression syntax is not valid.

" + }, + "Item":{ + "type":"structure", + "required":[ + "Name", + "Attributes" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the item." + }, + "AlternateNameEncoding":{ + "shape":"String", + "documentation":"

" + }, + "Attributes":{ + "shape":"AttributeList", + "documentation":"A list of attributes." + } + }, + "documentation":"

" + }, + "ItemList":{ + "type":"list", + "member":{ + "shape":"Item", + "locationName":"Item" + }, + "flattened":true + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "MaxNumberOfDomains":{ + "shape":"Integer", + "documentation":"The maximum number of domain names you want returned.\n\n The range is 1 to 100.\n\n The default setting is 100." + }, + "NextToken":{ + "shape":"String", + "documentation":"A string informing Amazon SimpleDB where to start the\n next list of domain names." + } + } + }, + "ListDomainsResult":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainNameList", + "documentation":"A list of domain names that match the expression." + }, + "NextToken":{ + "shape":"String", + "documentation":"An opaque token indicating that there are more domains than the specified\n MaxNumberOfDomains still available." + } + } + }, + "Long":{"type":"long"}, + "MissingParameter":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request must contain the specified missing parameter.

" + }, + "NoSuchDomain":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified domain does not exist.

" + }, + "NumberDomainAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes in this domain.

" + }, + "NumberDomainBytesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many bytes in this domain.

" + }, + "NumberDomainsExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many domains exist per this account.

" + }, + "NumberItemAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes in this item.

" + }, + "NumberSubmittedAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberSubmittedAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes exist in a single call.

" + }, + "NumberSubmittedItemsExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberSubmittedItemsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many items exist in a single call.

" + }, + "PutAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName", + "Attributes" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which to perform the operation." + }, + "ItemName":{ + "shape":"String", + "documentation":"The name of the item." + }, + "Attributes":{ + "shape":"ReplaceableAttributeList", + "documentation":"The list of attributes." + }, + "Expected":{ + "shape":"UpdateCondition", + "documentation":"The update condition which, if specified, determines whether the specified attributes\n will be updated or not. The update condition must be satisfied in order for this\n request to be processed and the attributes to be updated." + } + } + }, + "ReplaceableAttribute":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the replaceable attribute." + }, + "Value":{ + "shape":"String", + "documentation":"The value of the replaceable attribute." + }, + "Replace":{ + "shape":"Boolean", + "documentation":"A flag specifying whether or not to replace the attribute/value pair or\n to add a new attribute/value pair. The default setting is false." + } + }, + "documentation":"

" + }, + "ReplaceableAttributeList":{ + "type":"list", + "member":{ + "shape":"ReplaceableAttribute", + "locationName":"Attribute" + }, + "flattened":true + }, + "ReplaceableItem":{ + "type":"structure", + "required":[ + "Name", + "Attributes" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the replaceable item.", + "locationName":"ItemName" + }, + "Attributes":{ + "shape":"ReplaceableAttributeList", + "documentation":"The list of attributes for a replaceable item." + } + }, + "documentation":"

" + }, + "ReplaceableItemList":{ + "type":"list", + "member":{ + "shape":"ReplaceableItem", + "locationName":"Item" + }, + "flattened":true + }, + "RequestTimeout":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"RequestTimeout", + "httpStatusCode":408, + "senderFault":true + }, + "exception":true, + "documentation":"

A timeout occurred when attempting to\n query the specified domain with specified query expression.

" + }, + "SelectRequest":{ + "type":"structure", + "required":["SelectExpression"], + "members":{ + "SelectExpression":{ + "shape":"String", + "documentation":"The expression used to query the domain." + }, + "NextToken":{ + "shape":"String", + "documentation":"A string informing Amazon SimpleDB where to start the next\n list of ItemNames." + }, + "ConsistentRead":{ + "shape":"Boolean", + "documentation":"Determines whether or not strong consistency should be enforced when data is read\n from SimpleDB. If true, any data previously written to SimpleDB\n will be returned. Otherwise, results will be consistent eventually, and the client\n may not see data that was written immediately before your read." + } + } + }, + "SelectResult":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ItemList", + "documentation":"A list of items that match the select expression." + }, + "NextToken":{ + "shape":"String", + "documentation":"An opaque token indicating that more items than MaxNumberOfItems were matched,\n the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds." + } + } + }, + "String":{"type":"string"}, + "TooManyRequestedAttributes":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"TooManyRequestedAttributes", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Too many attributes requested.

" + }, + "UpdateCondition":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the attribute involved in the condition.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of an attribute. This value can only be\n specified when the Exists parameter is equal to true.

" + }, + "Exists":{ + "shape":"Boolean", + "documentation":"

A value specifying whether or not the specified attribute must exist with the specified\n value in order for the update condition to be satisfied. Specify true if\n the attribute must exist for the update condition to be satisfied. Specify false\n if the attribute should not exist in order for the update condition to be satisfied.

" + } + }, + "documentation":"

\n Specifies the conditions under which data should be updated.\n If an update condition is specified for a request,\n the data will only be updated if the condition is satisfied.\n For example, if an attribute with a specific name and value\n exists, or if a specific attribute doesn't exist.\n

" + } + } +} diff --git a/apis/sdb-2009-04-15.paginators.json b/apis/sdb-2009-04-15.paginators.json new file mode 100644 index 0000000000..2362098870 --- /dev/null +++ b/apis/sdb-2009-04-15.paginators.json @@ -0,0 +1,15 @@ +{ + "pagination": { + "ListDomains": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxNumberOfDomains", + "result_key": "DomainNames" + }, + "Select": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Items" + } + } +} diff --git a/apis/sdb-c2j.diff b/apis/sdb-c2j.diff new file mode 100644 index 0000000000..8d99ce29c2 --- /dev/null +++ b/apis/sdb-c2j.diff @@ -0,0 +1,52 @@ +diff --git a/apis/sdb-2009-04-15.full.json b/apis/sdb-2009-04-15.full.json +index 13c26ea..7438d55 100644 +--- a/apis/sdb-2009-04-15.full.json ++++ b/apis/sdb-2009-04-15.full.json +@@ -635,6 +635,29 @@ + } + } + }, ++ "DeletableAttribute":{ ++ "type":"structure", ++ "required":["Name"], ++ "members":{ ++ "Name":{ ++ "shape":"String", ++ "documentation":"The name of the attribute." ++ }, ++ "Value":{ ++ "shape":"String", ++ "documentation":"The value of the attribute." ++ } ++ }, ++ "documentation":"

" ++ }, ++ "DeletableAttributeList":{ ++ "type":"list", ++ "member":{ ++ "shape":"DeletableAttribute", ++ "locationName":"Attribute" ++ }, ++ "flattened":true ++ }, + "DeletableItem":{ + "type":"structure", + "required":["Name"], +@@ -643,7 +666,7 @@ + "shape":"String", + "locationName":"ItemName" + }, +- "Attributes":{"shape":"AttributeList"} ++ "Attributes":{"shape":"DeletableAttributeList"} + } + }, + "DeletableItemList":{ +@@ -670,7 +693,7 @@ + "documentation":"The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs." + }, + "Attributes":{ +- "shape":"AttributeList", ++ "shape":"DeletableAttributeList", + "documentation":"A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items." + }, + "Expected":{ diff --git a/apis/sns-2010-03-31.api.json b/apis/sns-2010-03-31.api.json new file mode 100644 index 0000000000..57b5504f4b --- /dev/null +++ b/apis/sns-2010-03-31.api.json @@ -0,0 +1,527 @@ +{ + "metadata": { + "apiVersion": "2010-03-31", + "endpointPrefix": "sns", + "serviceAbbreviation": "Amazon SNS", + "serviceFullName": "Amazon Simple Notification Service", + "signatureVersion": "v4", + "xmlNamespace": "http://sns.amazonaws.com/doc/2010-03-31/", + "protocol": "query" + }, + "operations": { + "AddPermission": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "Label", + "AWSAccountId", + "ActionName" + ], + "members": { + "TopicArn": {}, + "Label": {}, + "AWSAccountId": { + "type": "list", + "member": {} + }, + "ActionName": { + "type": "list", + "member": {} + } + } + } + }, + "ConfirmSubscription": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "Token" + ], + "members": { + "TopicArn": {}, + "Token": {}, + "AuthenticateOnUnsubscribe": {} + } + }, + "output": { + "resultWrapper": "ConfirmSubscriptionResult", + "type": "structure", + "members": { + "SubscriptionArn": {} + } + } + }, + "CreatePlatformApplication": { + "input": { + "type": "structure", + "required": [ + "Name", + "Platform", + "Attributes" + ], + "members": { + "Name": {}, + "Platform": {}, + "Attributes": { + "shape": "Sf" + } + } + }, + "output": { + "resultWrapper": "CreatePlatformApplicationResult", + "type": "structure", + "members": { + "PlatformApplicationArn": {} + } + } + }, + "CreatePlatformEndpoint": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn", + "Token" + ], + "members": { + "PlatformApplicationArn": {}, + "Token": {}, + "CustomUserData": {}, + "Attributes": { + "shape": "Sf" + } + } + }, + "output": { + "resultWrapper": "CreatePlatformEndpointResult", + "type": "structure", + "members": { + "EndpointArn": {} + } + } + }, + "CreateTopic": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + }, + "output": { + "resultWrapper": "CreateTopicResult", + "type": "structure", + "members": { + "TopicArn": {} + } + } + }, + "DeleteEndpoint": { + "input": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + } + }, + "DeletePlatformApplication": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn" + ], + "members": { + "PlatformApplicationArn": {} + } + } + }, + "DeleteTopic": { + "input": { + "type": "structure", + "required": [ + "TopicArn" + ], + "members": { + "TopicArn": {} + } + } + }, + "GetEndpointAttributes": { + "input": { + "type": "structure", + "required": [ + "EndpointArn" + ], + "members": { + "EndpointArn": {} + } + }, + "output": { + "resultWrapper": "GetEndpointAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "Sf" + } + } + } + }, + "GetPlatformApplicationAttributes": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn" + ], + "members": { + "PlatformApplicationArn": {} + } + }, + "output": { + "resultWrapper": "GetPlatformApplicationAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "Sf" + } + } + } + }, + "GetSubscriptionAttributes": { + "input": { + "type": "structure", + "required": [ + "SubscriptionArn" + ], + "members": { + "SubscriptionArn": {} + } + }, + "output": { + "resultWrapper": "GetSubscriptionAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "GetTopicAttributes": { + "input": { + "type": "structure", + "required": [ + "TopicArn" + ], + "members": { + "TopicArn": {} + } + }, + "output": { + "resultWrapper": "GetTopicAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "ListEndpointsByPlatformApplication": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn" + ], + "members": { + "PlatformApplicationArn": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListEndpointsByPlatformApplicationResult", + "type": "structure", + "members": { + "Endpoints": { + "type": "list", + "member": { + "type": "structure", + "members": { + "EndpointArn": {}, + "Attributes": { + "shape": "Sf" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListPlatformApplications": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListPlatformApplicationsResult", + "type": "structure", + "members": { + "PlatformApplications": { + "type": "list", + "member": { + "type": "structure", + "members": { + "PlatformApplicationArn": {}, + "Attributes": { + "shape": "Sf" + } + } + } + }, + "NextToken": {} + } + } + }, + "ListSubscriptions": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListSubscriptionsResult", + "type": "structure", + "members": { + "Subscriptions": { + "shape": "S1c" + }, + "NextToken": {} + } + } + }, + "ListSubscriptionsByTopic": { + "input": { + "type": "structure", + "required": [ + "TopicArn" + ], + "members": { + "TopicArn": {}, + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListSubscriptionsByTopicResult", + "type": "structure", + "members": { + "Subscriptions": { + "shape": "S1c" + }, + "NextToken": {} + } + } + }, + "ListTopics": { + "input": { + "type": "structure", + "members": { + "NextToken": {} + } + }, + "output": { + "resultWrapper": "ListTopicsResult", + "type": "structure", + "members": { + "Topics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TopicArn": {} + } + } + }, + "NextToken": {} + } + } + }, + "Publish": { + "input": { + "type": "structure", + "required": [ + "Message" + ], + "members": { + "TopicArn": {}, + "TargetArn": {}, + "Message": {}, + "Subject": {}, + "MessageStructure": {}, + "MessageAttributes": { + "type": "map", + "key": { + "locationName": "Name" + }, + "value": { + "locationName": "Value", + "type": "structure", + "required": [ + "DataType" + ], + "members": { + "DataType": {}, + "StringValue": {}, + "BinaryValue": { + "type": "blob" + } + } + } + } + } + }, + "output": { + "resultWrapper": "PublishResult", + "type": "structure", + "members": { + "MessageId": {} + } + } + }, + "RemovePermission": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "Label" + ], + "members": { + "TopicArn": {}, + "Label": {} + } + } + }, + "SetEndpointAttributes": { + "input": { + "type": "structure", + "required": [ + "EndpointArn", + "Attributes" + ], + "members": { + "EndpointArn": {}, + "Attributes": { + "shape": "Sf" + } + } + } + }, + "SetPlatformApplicationAttributes": { + "input": { + "type": "structure", + "required": [ + "PlatformApplicationArn", + "Attributes" + ], + "members": { + "PlatformApplicationArn": {}, + "Attributes": { + "shape": "Sf" + } + } + } + }, + "SetSubscriptionAttributes": { + "input": { + "type": "structure", + "required": [ + "SubscriptionArn", + "AttributeName" + ], + "members": { + "SubscriptionArn": {}, + "AttributeName": {}, + "AttributeValue": {} + } + } + }, + "SetTopicAttributes": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "AttributeName" + ], + "members": { + "TopicArn": {}, + "AttributeName": {}, + "AttributeValue": {} + } + } + }, + "Subscribe": { + "input": { + "type": "structure", + "required": [ + "TopicArn", + "Protocol" + ], + "members": { + "TopicArn": {}, + "Protocol": {}, + "Endpoint": {} + } + }, + "output": { + "resultWrapper": "SubscribeResult", + "type": "structure", + "members": { + "SubscriptionArn": {} + } + } + }, + "Unsubscribe": { + "input": { + "type": "structure", + "required": [ + "SubscriptionArn" + ], + "members": { + "SubscriptionArn": {} + } + } + } + }, + "shapes": { + "Sf": { + "type": "map", + "key": {}, + "value": {} + }, + "S1c": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SubscriptionArn": {}, + "Owner": {}, + "Protocol": {}, + "Endpoint": {}, + "TopicArn": {} + } + } + } + } +} \ No newline at end of file diff --git a/apis/sns-2010-03-31.full.json b/apis/sns-2010-03-31.full.json new file mode 100644 index 0000000000..16405c1e16 --- /dev/null +++ b/apis/sns-2010-03-31.full.json @@ -0,0 +1,2275 @@ +{ + "metadata":{ + "apiVersion":"2010-03-31", + "endpointPrefix":"sns", + "serviceAbbreviation":"Amazon SNS", + "serviceFullName":"Amazon Simple Notification Service", + "signatureVersion":"v4", + "xmlNamespace":"http://sns.amazonaws.com/doc/2010-03-31/", + "protocol":"query" + }, + "documentation":"Amazon Simple Notification Service\n \n\t

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. \n \tApplications can use Amazon SNS to easily push real-time notification messages \n \tto interested subscribers over multiple delivery protocols. For more information about this product\n\t\tsee http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls,\n\t\tsee the Amazon SNS Developer Guide.\n\t

\n

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. \n The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, \n retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services. \n

", + "operations":{ + "AddPermission":{ + "name":"AddPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddPermissionInput"}, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Test\n &ActionName.member.1=Publish\n &ActionName.member.2=GetTopicAttributes\n &Label=NewPermission\n &AWSAccountId.member.1=987654321000\n &AWSAccountId.member.2=876543210000\n &Action=AddPermission\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=k%2FAU%2FKp13pjndwJ7rr1sZszy6MZMlOhRBCHx1ZaZFiw%3D\n\n \n \n \n<AddPermissionResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>6a213e4e-33a8-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</AddPermissionResponse>\n \n \n" + }, + "ConfirmSubscription":{ + "name":"ConfirmSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ConfirmSubscriptionInput", + "documentation":"Input for ConfirmSubscription action." + }, + "output":{ + "shape":"ConfirmSubscriptionResponse", + "documentation":"Response for ConfirmSubscriptions action.", + "resultWrapper":"ConfirmSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionLimitExceededException", + "error":{ + "code":"SubscriptionLimitExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the customer already owns the maximum allowed number of subscriptions.

" + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Verifies an endpoint owner's intent to receive messages by validating\n the token sent to the endpoint by an earlier Subscribe action. If the\n token is valid, the action creates a new subscription and returns its\n Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".

\n\n \n\n https://sns.us-east-1.amazonaws.com/\n ?Action=ConfirmSubscription\n &TopicArn=arn:aws:sns:us-east-1:123456789012:My-Topic\n &Token=51b2ff3edb475b7d91550e0ab6edf0c1de2a34e6ebaf6\n c2262a001bcb7e051c43aa00022ceecce70bd2a67b2042da8d8\n eb47fef7a4e4e942d23e7fa56146b9ee35da040b4b8af564cc4\n 184a7391c834cb75d75c22981f776ad1ce8805e9bab29da2329\n 985337bb8095627907b46c8577c8440556b6f86582a95475802\n 6f41fc62041c4b3f67b0f5921232b5dae5aaca1\n\n \n \n \n<ConfirmSubscriptionResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ConfirmSubscriptionResult>\n <SubscriptionArn>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</SubscriptionArn>\n </ConfirmSubscriptionResult>\n <ResponseMetadata>\n <RequestId>7a50221f-3774-11df-a9b7-05d48da6f042</RequestId>\n </ResponseMetadata>\n</ConfirmSubscriptionResponse>\n \n \n" + }, + "CreatePlatformApplication":{ + "name":"CreatePlatformApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreatePlatformApplicationInput", + "documentation":"

Input for CreatePlatformApplication action.

" + }, + "output":{ + "shape":"CreatePlatformApplicationResponse", + "documentation":"

Response from CreatePlatformApplication action.

", + "resultWrapper":"CreatePlatformApplicationResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Creates a platform application object for one of the supported push notification services, \n such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using \n the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". \n For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. \n For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". \n The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action.\n For more information, see Using Amazon SNS Mobile Push Notifications. \n

\n \n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.2.key=PlatformPrincipal\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=AIzaSyClE2lcV2zEKTLYYo645zfk2jhQPFeyxDo\n&Attributes.entry.2.value=There+is+no+principal+for+GCM\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Signature=82sHzg1Wfbgisw3i%2BHA2OgBmRktsqUKFinknkq3u%2FQ4%3D\n&Timestamp=2013-07-01T15%3A49%3A50.354Z\n&Name=gcmpushapp\n&Attributes.entry.1.key=PlatformCredential\n&Action=CreatePlatformApplication\n&Version=2010-03-31\n&SignatureVersion=2\n&Platform=GCM\n\n \n \n \nHTTP/1.1 200 OK\n...\n<CreatePlatformApplicationResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <CreatePlatformApplicationResult>\n <PlatformApplicationArn>arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp</PlatformApplicationArn>\n </CreatePlatformApplicationResult>\n <ResponseMetadata>\n <RequestId>b6f0e78b-e9d4-5a0e-b973-adc04e8a4ff9</RequestId>\n </ResponseMetadata>\n</CreatePlatformApplicationResponse>\n\n \n " + }, + "CreatePlatformEndpoint":{ + "name":"CreatePlatformEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreatePlatformEndpointInput", + "documentation":"

Input for CreatePlatformEndpoint action.

" + }, + "output":{ + "shape":"CreateEndpointResponse", + "documentation":"

Response from CreateEndpoint action.

", + "resultWrapper":"CreatePlatformEndpointResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. \n CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is\n returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe \n action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, \n that endpoint's ARN is returned without creating a new endpoint. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. \n For more information, see Creating an Amazon SNS Endpoint for Baidu. \n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=CreatePlatformEndpoint\n&SignatureMethod=HmacSHA256\n&CustomUserData=UserId%3D27576823\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Token=APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=Rg5vXBS6OfgPtWkt1u32p1w14uiGh%2BKOicvXNWTEz2w%3D\n&Timestamp=2013-07-01T15%3A49%3A50.598Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<CreatePlatformEndpointResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <CreatePlatformEndpointResult>\n <EndpointArn>arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3</EndpointArn>\n </CreatePlatformEndpointResult>\n <ResponseMetadata>\n <RequestId>6613341d-3e15-53f7-bf3c-7e56994ba278</RequestId>\n </ResponseMetadata>\n</CreatePlatformEndpointResponse>\n\n \n " + }, + "CreateTopic":{ + "name":"CreateTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateTopicInput", + "documentation":"

Input for CreateTopic action.

" + }, + "output":{ + "shape":"CreateTopicResponse", + "documentation":"

Response from CreateTopic action.

", + "resultWrapper":"CreateTopicResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"TopicLimitExceededException", + "error":{ + "code":"TopicLimitExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the customer already owns the maximum allowed number of topics.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Creates a topic to which notifications can be published. Users can create\n at most 3000 topics. For more information, see http://aws.amazon.com/sns. \n This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is \n returned without creating a new topic.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?Name=My-Topic\n &Action=CreateTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=gfzIF53exFVdpSNb8AiwN3Lv%2FNYXh6S%2Br3yySK70oX4%3D\n\n \n \n \n <CreateTopicResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <CreateTopicResult>\n <TopicArn>arn:aws:sns:us-east-1:123456789012:My-Topic</TopicArn>\n </CreateTopicResult>\n <ResponseMetadata>\n <RequestId>a8dec8b3-33a4-11df-8963-01868b7c937a</RequestId>\n </ResponseMetadata>\n </CreateTopicResponse>\n \n \n" + }, + "DeleteEndpoint":{ + "name":"DeleteEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteEndpointInput", + "documentation":"

Input for DeleteEndpoint action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Deletes the endpoint from Amazon SNS. This action is idempotent. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=DeleteEndpoint\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=LIc6GI3JbNhmHBEDmSxzZp648XPe5CMeFny%2BTQFtomQ%3D\n&Timestamp=2013-07-01T23%3A00%3A12.456Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<DeleteEndpointResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>c1d2b191-353c-5a5f-8969-fbdd3900afa8</RequestId>\n </ResponseMetadata>\n</DeleteEndpointResponse>\n\n \n " + }, + "DeletePlatformApplication":{ + "name":"DeletePlatformApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeletePlatformApplicationInput", + "documentation":"

Input for DeletePlatformApplication action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Deletes a platform application object for one of the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=DeletePlatformApplication\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=Mh7X%2BQo%2BGpcm5B1IpkovBaRiJCJOqvFlIOYzL62SGrg%3D\n&Timestamp=2013-07-01T23%3A02%3A03.872Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<DeletePlatformApplicationResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>097dac18-7a77-5823-a8dd-e65476dcb037</RequestId>\n </ResponseMetadata>\n</DeletePlatformApplicationResponse>\n\n \n " + }, + "DeleteTopic":{ + "name":"DeleteTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTopicInput"}, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Deletes a topic and all its subscriptions. Deleting a topic might\n prevent some messages previously sent to the topic from being delivered to\n subscribers. This action is idempotent, so deleting a topic that does not\n exist does not result in an error.

\n\n\n\n http://sns.us-east-1.amazonaws.com/\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=DeleteTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n\n\n\n\n<DeleteTopicResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>f3aa9ac9-3c3d-11df-8235-9dab105e9c32</RequestId>\n </ResponseMetadata>\n</DeleteTopicResponse>\n\n\n" + }, + "GetEndpointAttributes":{ + "name":"GetEndpointAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetEndpointAttributesInput", + "documentation":"

Input for GetEndpointAttributes action.

" + }, + "output":{ + "shape":"GetEndpointAttributesResponse", + "documentation":"

Response from GetEndpointAttributes of the EndpointArn.

", + "resultWrapper":"GetEndpointAttributesResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=GetEndpointAttributes\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=%2B2egbEoT4npw3p5H3wiIdzZBoTn4KI3UWmMFyBsHH9c%3D\n&Timestamp=2013-07-01T22%3A44%3A56.515Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<GetEndpointAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <GetEndpointAttributesResult>\n <Attributes>\n <entry>\n <key>Enabled</key>\n <value>true</value>\n </entry>\n <entry>\n <key>CustomUserData</key>\n <value>UserId=01234567</value>\n </entry>\n <entry>\n <key>Token</key>\n <value>APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE</value>\n </entry>\n </Attributes>\n </GetEndpointAttributesResult>\n <ResponseMetadata>\n <RequestId>6c725a19-a142-5b77-94f9-1055a9ea04e7</RequestId>\n </ResponseMetadata>\n</GetEndpointAttributesResponse>\n\n \n " + }, + "GetPlatformApplicationAttributes":{ + "name":"GetPlatformApplicationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetPlatformApplicationAttributesInput", + "documentation":"

Input for GetPlatformApplicationAttributes action.

" + }, + "output":{ + "shape":"GetPlatformApplicationAttributesResponse", + "documentation":"

Response for GetPlatformApplicationAttributes action.

", + "resultWrapper":"GetPlatformApplicationAttributesResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Retrieves the attributes of the platform application object for the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=GetPlatformApplicationAttributes\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=UGMaCq8CCJGSYXO9Ehr2VuHIBYSe6WbxkqgMKRslTK4%3D\n&Timestamp=2013-07-01T22%3A40%3A50.643Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<GetPlatformApplicationAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <GetPlatformApplicationAttributesResult>\n <Attributes>\n <entry>\n <key>AllowEndpointPolicies</key>\n <value>false</value>\n </entry>\n </Attributes>\n </GetPlatformApplicationAttributesResult>\n <ResponseMetadata>\n <RequestId>74848df2-87f6-55ed-890c-c7be80442462</RequestId>\n </ResponseMetadata>\n</GetPlatformApplicationAttributesResponse>\n\n \n " + }, + "GetSubscriptionAttributes":{ + "name":"GetSubscriptionAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetSubscriptionAttributesInput", + "documentation":"

Input for GetSubscriptionAttributes.

" + }, + "output":{ + "shape":"GetSubscriptionAttributesResponse", + "documentation":"

Response for GetSubscriptionAttributes action.

", + "resultWrapper":"GetSubscriptionAttributesResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Returns all of the properties of a subscription.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &Action=GetSubscriptionAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=92lBGRVq0%2BxhaACaBGqtdemy%2Bi9isfgyTljCbJM80Yk%3D\n\n \n \n \n<GetSubscriptionAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <GetSubscriptionAttributesResult>\n <Attributes>\n <entry>\n <key>Owner</key>\n <value>123456789012</value>\n </entry>\n <entry>\n <key>DeliveryPolicy</key>\n <value>{&quot;healthyRetryPolicy&quot;:{&quot;numRetries&quot;:10}}</value>\n </entry>\n <entry>\n <key>SubscriptionArn</key>\n <value>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</value>\n </entry>\n </Attributes>\n </GetSubscriptionAttributesResult>\n <ResponseMetadata>\n <RequestId>057f074c-33a7-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</GetTopicAttributesResponse>\n \n \n" + }, + "GetTopicAttributes":{ + "name":"GetTopicAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetTopicAttributesInput", + "documentation":"

Input for GetTopicAttributes action.

" + }, + "output":{ + "shape":"GetTopicAttributesResponse", + "documentation":"

Response for GetTopicAttributes action.

", + "resultWrapper":"GetTopicAttributesResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Returns all of the properties of a topic. \n Topic properties returned might differ based on the authorization of the user.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=GetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=92lBGRVq0%2BxhaACaBGqtdemy%2Bi9isfgyTljCbJM80Yk%3D\n\n \n \n \n<GetTopicAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <GetTopicAttributesResult>\n <Attributes>\n <entry>\n <key>Owner</key>\n <value>123456789012</value>\n </entry>\n <entry>\n <key>Policy</key>\n <value>{\n&quot;Version&quot;:&quot;2008-10-17&quot;,&quot;Id&quot;:&quot;us-east-1/698519295917/test__default_policy_ID&quot;,&quot;Statement&quot; : [{&quot;Effect&quot;:&quot;Allow&quot;,&quot;Sid&quot;:&quot;us-east-1/698519295917/test__default_statement_ID&quot;,&quot;Principal&quot; : {&quot;AWS&quot;: &quot;*&quot;},&quot;Action&quot;:[&quot;SNS:GetTopicAttributes&quot;,&quot;SNS:SetTopicAttributes&quot;,&quot;SNS:AddPermission&quot;,&quot;SNS:RemovePermission&quot;,&quot;SNS:DeleteTopic&quot;,&quot;SNS:Subscribe&quot;,&quot;SNS:ListSubscriptionsByTopic&quot;,&quot;SNS:Publish&quot;,&quot;SNS:Receive&quot;],&quot;Resource&quot;:&quot;arn:aws:sns:us-east-1:698519295917:test&quot;,&quot;Condition&quot; : {&quot;StringLike&quot; : {&quot;AWS:SourceArn&quot;: &quot;arn:aws:*:*:698519295917:*&quot;}}}]}</value>\n </entry>\n <entry>\n <key>TopicArn</key>\n <value>arn:aws:sns:us-east-1:123456789012:My-Topic</value>\n </entry>\n </Attributes>\n </GetTopicAttributesResult>\n <ResponseMetadata>\n <RequestId>057f074c-33a7-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</GetTopicAttributesResponse>\n \n \n" + }, + "ListEndpointsByPlatformApplication":{ + "name":"ListEndpointsByPlatformApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListEndpointsByPlatformApplicationInput", + "documentation":"

Input for ListEndpointsByPlatformApplication action.

" + }, + "output":{ + "shape":"ListEndpointsByPlatformApplicationResponse", + "documentation":"

Response for ListEndpointsByPlatformApplication action.

", + "resultWrapper":"ListEndpointsByPlatformApplicationResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. \n The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100.\n If additional records are available after the first page results, then a NextToken string will be returned. \n To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. \n When there are no more records to return, NextToken will be null.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=ListEndpointsByPlatformApplication\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=e6H4sJSCRBBlh%2BaigB%2FtYgp4%2Bjl7dikAQ6WKf%2BMTwNM%3D\n&Timestamp=2013-07-01T23%3A00%3A52.515Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<ListEndpointsByPlatformApplicationResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListEndpointsByPlatformApplicationResult>\n <Endpoints>\n <member>\n <EndpointArn>arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3</EndpointArn>\n <Attributes>\n <entry>\n <key>Enabled</key>\n <value>true</value>\n </entry>\n <entry>\n <key>CustomUserData</key>\n <value>UserId=27576823</value>\n </entry>\n <entry>\n <key>Token</key>\n <value>APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE</value>\n </entry>\n </Attributes>\n </member>\n </Endpoints>\n </ListEndpointsByPlatformApplicationResult>\n <ResponseMetadata>\n <RequestId>9a48768c-dac8-5a60-aec0-3cc27ea08d96</RequestId>\n </ResponseMetadata>\n</ListEndpointsByPlatformApplicationResponse>\n\n \n " + }, + "ListPlatformApplications":{ + "name":"ListPlatformApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListPlatformApplicationsInput", + "documentation":"

Input for ListPlatformApplications action.

" + }, + "output":{ + "shape":"ListPlatformApplicationsResponse", + "documentation":"

Response for ListPlatformApplications action.

", + "resultWrapper":"ListPlatformApplicationsResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Lists the platform application objects for the supported push notification services, \n such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100.\n If additional records are available after the first page results, then a NextToken string will be returned. \n To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. \n When there are no more records to return, NextToken will be null.\n \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=ListPlatformApplications\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=drVbTuyR5N9e88WJMNPzBOjNFNvawkCaMfZI0xa9kIQ%3D\n&Timestamp=2013-07-01T22%3A33%3A55.618Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<ListPlatformApplicationsResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListPlatformApplicationsResult>\n <PlatformApplications>\n <member>\n <PlatformApplicationArn>arn:aws:sns:us-west-2:123456789012:app/APNS_SANDBOX/apnspushapp</PlatformApplicationArn>\n <Attributes>\n <entry>\n <key>AllowEndpointPolicies</key>\n <value>false</value>\n </entry>\n </Attributes>\n </member>\n <member>\n <PlatformApplicationArn>arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp</PlatformApplicationArn>\n <Attributes>\n <entry>\n <key>AllowEndpointPolicies</key>\n <value>false</value>\n </entry>\n </Attributes>\n </member>\n </PlatformApplications>\n </ListPlatformApplicationsResult>\n <ResponseMetadata>\n <RequestId>315a335e-85d8-52df-9349-791283cbb529</RequestId>\n </ResponseMetadata>\n</ListPlatformApplicationsResponse>\n\n \n " + }, + "ListSubscriptions":{ + "name":"ListSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListSubscriptionsInput", + "documentation":"Input for ListSubscriptions action." + }, + "output":{ + "shape":"ListSubscriptionsResponse", + "documentation":"

Response for ListSubscriptions action

", + "resultWrapper":"ListSubscriptionsResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Returns a list of the requester's subscriptions. Each call returns a limited list\n of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a \n new ListSubscriptions call to get further results.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n &Action=ListSubscriptions\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=SZmBxEPqfs9R7xxhSt6C1b7PnOEvg%2BSVyyMYJfLRFCA%3D\n\n \n \n \n<ListSubscriptionsResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListSubscriptionsResult>\n <Subscriptions>\n <member>\n <TopicArn>arn:aws:sns:us-east-1:698519295917:My-Topic</TopicArn>\n <Protocol>email</Protocol>\n <SubscriptionArn>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</SubscriptionArn>\n <Owner>123456789012</Owner>\n <Endpoint>example@amazon.com</Endpoint>\n </member>\n </Subscriptions>\n </ListSubscriptionsResult>\n <ResponseMetadata>\n <RequestId>384ac68d-3775-11df-8963-01868b7c937a</RequestId>\n </ResponseMetadata>\n</ListSubscriptionsResponse>\n \n \n" + }, + "ListSubscriptionsByTopic":{ + "name":"ListSubscriptionsByTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListSubscriptionsByTopicInput", + "documentation":"

Input for ListSubscriptionsByTopic action.

" + }, + "output":{ + "shape":"ListSubscriptionsByTopicResponse", + "documentation":"

Response for ListSubscriptionsByTopic action.

", + "resultWrapper":"ListSubscriptionsByTopicResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Returns a list of the subscriptions to a specific topic. Each call returns \n a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken \n parameter in a new ListSubscriptionsByTopic call to get further results.

\n \n \n \n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=ListSubscriptionsByTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=SZmBxEPqfs9R7xxhSt6C1b7PnOEvg%2BSVyyMYJfLRFCA%3D\n\n \n \n \n<ListSubscriptionsByTopicResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListSubscriptionsByTopicResult>\n <Subscriptions>\n <member>\n <TopicArn>arn:aws:sns:us-east-1:123456789012:My-Topic</TopicArn>\n <Protocol>email</Protocol>\n <SubscriptionArn>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</SubscriptionArn>\n <Owner>123456789012</Owner>\n <Endpoint>example@amazon.com</Endpoint>\n </member>\n </Subscriptions>\n </ListSubscriptionsByTopicResult>\n <ResponseMetadata>\n <RequestId>b9275252-3774-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</ListSubscriptionsByTopicResponse>\n \n \n " + }, + "ListTopics":{ + "name":"ListTopics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTopicsInput"}, + "output":{ + "shape":"ListTopicsResponse", + "documentation":"

Response for ListTopics action.

", + "resultWrapper":"ListTopicsResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If\n there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get \n further results.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?Action=ListTopics\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=tPg1qKNTNVPydnL3Yx5Fqm2O9GxCr9vh3EF5r9%2F5%2BJs%3D\n\n \n \n \n<ListTopicsResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListTopicsResult>\n <Topics>\n <member>\n <TopicArn>arn:aws:sns:us-east-1:123456789012:My-Topic</TopicArn>\n </member>\n </Topics>\n </ListTopicsResult>\n <ResponseMetadata>\n <RequestId>3f1478c7-33a9-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</ListTopicsResponse>\n \n \n" + }, + "Publish":{ + "name":"Publish", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PublishInput", + "documentation":"

Input for Publish action.

" + }, + "output":{ + "shape":"PublishResponse", + "documentation":"

Response for Publish action.

", + "resultWrapper":"PublishResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"ParameterValueInvalid", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + { + "shape":"EndpointDisabledException", + "error":{ + "code":"EndpointDisabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Exception error indicating endpoint disabled.

" + }, + { + "shape":"PlatformApplicationDisabledException", + "error":{ + "code":"PlatformApplicationDisabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Exception error indicating platform application disabled.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Sends a message to all of a topic's subscribed endpoints. When a\n messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it \n to the topic's subscribers shortly. The format of the outgoing message to each\n subscribed endpoint depends on the notification protocol selected.

\n

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, \n you must specify the EndpointArn. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. \n The second example below shows a request and response for publishing to a mobile endpoint.\n

\n \n \n \n The following example publishes the same message to all protocols:\n \n http://sns.us-east-1.amazonaws.com/\n ?Subject=My%20first%20message\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A698519295917%3AMy-Topic\n &Message=Hello%20world%21\n &Action=Publish\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n &Signature=9GZysQ4Jpnz%2BHklqM7VFTvEcjR2LIUtn6jW47054xxE%3D\n \n Use the following JSON object format for the Message parameter to send different messages to each protocol (linebreaks added for readability):\n {\n \"default\" : \"some message\",\n \"email\" : \"some email message\",\n \"email-json\" : \"some email-json message\",\n \"http\" : \"some http message\",\n \"https\" : \"some https message\",\n \"sqs\" : \"some sqs message\"\n }\n \n\n \n \n \n<PublishResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <PublishResult>\n <MessageId>94f20ce6-13c5-43a0-9a9e-ca52d816e90b</MessageId>\n </PublishResult>\n <ResponseMetadata>\n <RequestId>f187a3c1-376f-11df-8963-01868b7c937a</RequestId>\n </ResponseMetadata>\n</PublishResponse>\n \n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=Publish\n&Message=%7B%22default%22%3A%22This+is+the+default+Message%22%2C%22APNS_SANDBOX%22%3A%22%7B+%5C%22aps%5C%22+%3A+%7B+%5C%22alert%5C%22+%3A+%5C%22You+have+got+email.%5C%22%2C+%5C%22badge%5C%22+%3A+9%2C%5C%22sound%5C%22+%3A%5C%22default%5C%22%7D%7D%22%7D\n&TargetArn=arn%3Aaws%3Asns%3Aus-west-2%3A803981987763%3Aendpoint%2FAPNS_SANDBOX%2Fpushapp%2F98e9ced9-f136-3893-9d60-776547eafebb\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=vmqc4XRupKAxsDAdN4j4Ayw5LQljXMps3kss4bkDfCk%3D\n&Timestamp=2013-07-18T22%3A44%3A09.452Z\n&MessageStructure=json\n \n\n \n \n \nHTTP/1.1 200 OK\n...\n<PublishResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <PublishResult>\n <MessageId>567910cd-659e-55d4-8ccb-5aaf14679dc0</MessageId>\n </PublishResult>\n <ResponseMetadata>\n <RequestId>d74b8436-ae13-5ab4-a9ff-ce54dfea72a0</RequestId>\n </ResponseMetadata>\n</PublishResponse>\n \n \n " + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemovePermissionInput", + "documentation":"

Input for RemovePermission action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Removes a statement from a topic's access control policy.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Test\n &Label=NewPermission\n &Action=RemovePermission\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=N1abwRY9i7zaSQmbAlm71pPf9EEFOqNbQL1alzw2yCg%3D\n\n \n \n \n<RemovePermissionResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>d170b150-33a8-11df-995a-2d6fbe836cc1</RequestId>\n </ResponseMetadata>\n</RemovePermissionResponse>\n \n \n" + }, + "SetEndpointAttributes":{ + "name":"SetEndpointAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetEndpointAttributesInput", + "documentation":"

Input for SetEndpointAttributes action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.1.key=CustomUserData\n&Action=SetEndpointAttributes\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=My+custom+userdata\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=CFTGfGOS5vgSU3%2FZgv2h%2FJdWgr2JQdDJSrUU9k38wSM%3D\n&Timestamp=2013-07-01T22%3A56%3A45.582Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<SetEndpointAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>2fe0bfc7-3e85-5ee5-a9e2-f58b35e85f6a</RequestId>\n </ResponseMetadata>\n</SetEndpointAttributesResponse>\n\n \n " + }, + "SetPlatformApplicationAttributes":{ + "name":"SetPlatformApplicationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetPlatformApplicationAttributesInput", + "documentation":"

Input for SetPlatformApplicationAttributes action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Sets the attributes of the platform application object for the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.1.key=EventEndpointCreated&PlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=SetPlatformApplicationAttributes\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Atopicarn\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=06L2TsW3jiH%2FGKDYuT8w4NojSrTf4Ig2GKqGeJPhPT4%3D\n&Timestamp=2013-07-01T22%3A53%3A17.800Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n<SetPlatformApplicationAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>cf577bcc-b3dc-5463-88f1-3180b9412395</RequestId>\n </ResponseMetadata>\n</SetPlatformApplicationAttributesResponse>\n\n \n " + }, + "SetSubscriptionAttributes":{ + "name":"SetSubscriptionAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetSubscriptionAttributesInput", + "documentation":"

Input for SetSubscriptionAttributes action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Allows a subscription owner to set an attribute of the topic to a new value.

\n\n \n \nThe following example sets the delivery policy to 5 total retries\n \n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue={\"healthyRetryPolicy\":{\"numRetries\":5}}\n &SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &AttributeName=DeliveryPolicy\n &Action=SetSubscriptionAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n \nThe JSON format for the DeliveryPolicy AttributeValue (linebreaks added for readability):\n{\n \"healthyRetryPolicy\": \n {\n \"minDelayTarget\": <int>,\n \"maxDelayTarget\": <int>,\n \"numRetries\": <int>,\n \"numMaxDelayRetries\": <int>,\n \"backoffFunction\": \"<linear|arithmetic|geometric|exponential>\"\n },\n \"throttlePolicy\":\n {\n \"maxReceivesPerSecond\": <int>\n }\n}\n \n \n \n<SetSubscriptionAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>a8763b99-33a7-11df-a9b7-05d48da6f042</RequestId>\n </ResponseMetadata>\n</SetSubscriptionAttributesResponse>\n \n \n" + }, + "SetTopicAttributes":{ + "name":"SetTopicAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetTopicAttributesInput", + "documentation":"

Input for SetTopicAttributes action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Allows a topic owner to set an attribute of the topic to a new value.

\n\n \nThe following example sets the DisplayName attribute to MyTopicName\n\n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue=MyTopicName\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &AttributeName=DisplayName\n &Action=SetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n \nThe following example sets the delivery policy to 5 total retries\n \n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue={\"http\":{\"defaultHealthyRetryPolicy\":{\"numRetries\":5}}}\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &AttributeName=DeliveryPolicy\n &Action=SetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D \n \nThe JSON format for the DeliveryPolicy AttributeValue (linebreaks added for readability):\n{\n \"http\": {\n \"defaultHealthyRetryPolicy\": \n {\n \"minDelayTarget\": <int>,\n \"maxDelayTarget\": <int>,\n \"numRetries\": <int>,\n \"numMaxDelayRetries\": <int>,\n \"backoffFunction\": \"<linear|arithmetic|geometric|exponential>\"\n },\n \"disableSubscriptionOverrides\": <boolean>,\n \"defaultThrottlePolicy\": \n {\n \"maxReceivesPerSecond\": <int>\n }\n }\n \n \n \n<SetTopicAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>a8763b99-33a7-11df-a9b7-05d48da6f042</RequestId>\n </ResponseMetadata>\n</SetTopicAttributesResponse>\n \n \n" + }, + "Subscribe":{ + "name":"Subscribe", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SubscribeInput", + "documentation":"Input for Subscribe action." + }, + "output":{ + "shape":"SubscribeResponse", + "documentation":"Response for Subscribe action.", + "resultWrapper":"SubscribeResult" + }, + "errors":[ + { + "shape":"SubscriptionLimitExceededException", + "error":{ + "code":"SubscriptionLimitExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the customer already owns the maximum allowed number of subscriptions.

" + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + } + ], + "documentation":"

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a\n subscription, the endpoint owner must call the ConfirmSubscription\n action with the token from the confirmation message. Confirmation tokens are\n valid for three days.

\n\n \n The following example Query request subscribes an SQS queue to an SNS topic. \n For more information, see \n Subscribe Queue to Amazon SNS Topic\n in the Amazon SQS Developer Guide. \n \n \n\n http://sns.us-west-2.amazonaws.com/\n &Action=Subscribe\n &Endpoint=arn%3Aaws%3Asqs%3Aus-west-2%3A123456789012%3AMyQueue\n &Version=2010-03-31\n &Protocol=sqs\n &TopicArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3AMyTopic \n\n \n \n \n<SubscribeResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <SubscribeResult>\n <SubscriptionArn>arn:aws:sns:us-west-2:123456789012:MyTopic:6b0e71bd-7e97-4d97-80ce-4a0994e55286</SubscriptionArn>\n </SubscribeResult>\n <ResponseMetadata>\n <RequestId>c4407779-24a4-56fa-982c-3d927f93a775</RequestId>\n </ResponseMetadata>\n</SubscribeResponse>\n \n \n \n \n" + }, + "Unsubscribe":{ + "name":"Unsubscribe", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UnsubscribeInput", + "documentation":"

Input for Unsubscribe action.

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + { + "shape":"AuthorizationErrorException", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + } + ], + "documentation":"

Deletes a subscription. If the subscription requires authentication for \n deletion, only the owner of the subscription or the topic's owner \n can unsubscribe, and an AWS signature is required. If the \n Unsubscribe call does not require authentication and the requester is not \n the subscription owner, a final cancellation message is delivered to the \n endpoint, so that the endpoint owner can easily resubscribe to the topic if \n the Unsubscribe request was unintended.

\n \n \n \n http://sns.us-east-1.amazonaws.com/\n ?SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &Action=Unsubscribe\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=e8IwhPzuWeMvPDVrN7jUVxasd3Wv2LuO8x6rE23VCv8%3D\n\n \n \n \n<UnsubscribeResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>18e0ac39-3776-11df-84c0-b93cc1666b84</RequestId>\n </ResponseMetadata>\n</UnsubscribeResponse>\n \n \n " + } + }, + "shapes":{ + "ActionsList":{ + "type":"list", + "member":{"shape":"action"} + }, + "AddPermissionInput":{ + "type":"structure", + "required":[ + "TopicArn", + "Label", + "AWSAccountId", + "ActionName" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the topic whose access control policy you wish to modify.

" + }, + "Label":{ + "shape":"label", + "documentation":"

A unique identifier for the new policy statement.

" + }, + "AWSAccountId":{ + "shape":"DelegatesList", + "documentation":"

The AWS account IDs of the users (principals) who will be given access to the specified\n actions. The users must have AWS accounts, but do not need to be signed up \n for this service.

" + }, + "ActionName":{ + "shape":"ActionsList", + "documentation":"

The action you want to allow for the specified principal(s).

\n

Valid values: any Amazon SNS action name.

" + } + } + }, + "AuthorizationErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the user has been denied access to the requested resource.

" + }, + "Binary":{"type":"blob"}, + "ConfirmSubscriptionInput":{ + "type":"structure", + "required":[ + "TopicArn", + "Token" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the topic for which you wish to confirm a subscription.

" + }, + "Token":{ + "shape":"token", + "documentation":"

Short-lived token sent to an endpoint during the Subscribe action.

" + }, + "AuthenticateOnUnsubscribe":{ + "shape":"authenticateOnUnsubscribe", + "documentation":"

Disallows unauthenticated unsubscribes of the subscription. \n If the value of this parameter is true and the request has an AWS signature, then only the topic owner\n and the subscription owner can unsubscribe the endpoint. The unsubscribe\n action requires AWS authentication.

" + } + }, + "documentation":"Input for ConfirmSubscription action." + }, + "ConfirmSubscriptionResponse":{ + "type":"structure", + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

The ARN of the created subscription.

" + } + }, + "documentation":"Response for ConfirmSubscriptions action." + }, + "CreateEndpointResponse":{ + "type":"structure", + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

EndpointArn returned from CreateEndpoint action.

" + } + }, + "documentation":"

Response from CreateEndpoint action.

" + }, + "CreatePlatformApplicationInput":{ + "type":"structure", + "required":[ + "Name", + "Platform", + "Attributes" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

" + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

For a list of attributes, see SetPlatformApplicationAttributes

" + } + }, + "documentation":"

Input for CreatePlatformApplication action.

" + }, + "CreatePlatformApplicationResponse":{ + "type":"structure", + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

PlatformApplicationArn is returned.

" + } + }, + "documentation":"

Response from CreatePlatformApplication action.

" + }, + "CreatePlatformEndpointInput":{ + "type":"structure", + "required":[ + "PlatformApplicationArn", + "Token" + ], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

" + }, + "Token":{ + "shape":"String", + "documentation":"

Unique identifier created by the notification service for an app on a device. \n The specific name for Token will vary, depending on which notification service is being used. \n For example, when using APNS as the notification service, you need the device token. \n Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

" + }, + "CustomUserData":{ + "shape":"String", + "documentation":"

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

" + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

For a list of attributes, see SetEndpointAttributes.

" + } + }, + "documentation":"

Input for CreatePlatformEndpoint action.

" + }, + "CreateTopicInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"topicName", + "documentation":"

The name of the topic you want to create.

\n

Constraints: Topic names must be made up of \n only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be \n between 1 and 256 characters long.

" + } + }, + "documentation":"

Input for CreateTopic action.

" + }, + "CreateTopicResponse":{ + "type":"structure", + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The Amazon Resource Name (ARN) assigned to the created topic.

" + } + }, + "documentation":"

Response from CreateTopic action.

" + }, + "DelegatesList":{ + "type":"list", + "member":{"shape":"delegate"} + }, + "DeleteEndpointInput":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

EndpointArn of endpoint to delete.

" + } + }, + "documentation":"

Input for DeleteEndpoint action.

" + }, + "DeletePlatformApplicationInput":{ + "type":"structure", + "required":["PlatformApplicationArn"], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

PlatformApplicationArn of platform application object to delete.

" + } + }, + "documentation":"

Input for DeletePlatformApplication action.

" + }, + "DeleteTopicInput":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the topic you want to delete.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=DeleteTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D\n\n \n \n \n<DeleteTopicResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>fba800b9-3765-11df-8cf3-c58c53254dfb</RequestId>\n </ResponseMetadata>\n</DeleteTopicResponse>\n \n \n" + } + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

EndpointArn for mobile app and device.

" + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

Attributes for endpoint.

" + } + }, + "documentation":"

Endpoint for mobile app and device.

" + }, + "EndpointDisabledException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

Message for endpoint disabled.

" + } + }, + "error":{ + "code":"EndpointDisabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Exception error indicating endpoint disabled.

" + }, + "GetEndpointAttributesInput":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

EndpointArn for GetEndpointAttributes input.

" + } + }, + "documentation":"

Input for GetEndpointAttributes action.

" + }, + "GetEndpointAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

Attributes include the following:

\n " + } + }, + "documentation":"

Response from GetEndpointAttributes of the EndpointArn.

" + }, + "GetPlatformApplicationAttributesInput":{ + "type":"structure", + "required":["PlatformApplicationArn"], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

" + } + }, + "documentation":"

Input for GetPlatformApplicationAttributes action.

" + }, + "GetPlatformApplicationAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

Attributes include the following:

\n " + } + }, + "documentation":"

Response for GetPlatformApplicationAttributes action.

" + }, + "GetSubscriptionAttributesInput":{ + "type":"structure", + "required":["SubscriptionArn"], + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

The ARN of the subscription whose properties you want to get.

" + } + }, + "documentation":"

Input for GetSubscriptionAttributes.

" + }, + "GetSubscriptionAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"SubscriptionAttributesMap", + "documentation":"

A map of the subscription's attributes. Attributes in this map include the following:

\n " + } + }, + "documentation":"

Response for GetSubscriptionAttributes action.

" + }, + "GetTopicAttributesInput":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the topic whose properties you want to get.

" + } + }, + "documentation":"

Input for GetTopicAttributes action.

" + }, + "GetTopicAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"TopicAttributesMap", + "documentation":"

A map of the topic's attributes. Attributes in this map include the following:

\n " + } + }, + "documentation":"

Response for GetTopicAttributes action.

" + }, + "InternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"

Indicates an internal service error.

" + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "error":{ + "code":"ParameterValueInvalid", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

" + }, + "ListEndpointsByPlatformApplicationInput":{ + "type":"structure", + "required":["PlatformApplicationArn"], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

" + } + }, + "documentation":"

Input for ListEndpointsByPlatformApplication action.

" + }, + "ListEndpointsByPlatformApplicationResponse":{ + "type":"structure", + "members":{ + "Endpoints":{ + "shape":"ListOfEndpoints", + "documentation":"

Endpoints returned for ListEndpointsByPlatformApplication action.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

" + } + }, + "documentation":"

Response for ListEndpointsByPlatformApplication action.

" + }, + "ListOfEndpoints":{ + "type":"list", + "member":{"shape":"Endpoint"} + }, + "ListOfPlatformApplications":{ + "type":"list", + "member":{"shape":"PlatformApplication"} + }, + "ListPlatformApplicationsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

" + } + }, + "documentation":"

Input for ListPlatformApplications action.

" + }, + "ListPlatformApplicationsResponse":{ + "type":"structure", + "members":{ + "PlatformApplications":{ + "shape":"ListOfPlatformApplications", + "documentation":"

Platform applications returned when calling ListPlatformApplications action.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

" + } + }, + "documentation":"

Response for ListPlatformApplications action.

" + }, + "ListSubscriptionsByTopicInput":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the topic for which you wish to find subscriptions.

" + }, + "NextToken":{ + "shape":"nextToken", + "documentation":"

Token returned by the previous ListSubscriptionsByTopic request.

" + } + }, + "documentation":"

Input for ListSubscriptionsByTopic action.

" + }, + "ListSubscriptionsByTopicResponse":{ + "type":"structure", + "members":{ + "Subscriptions":{ + "shape":"SubscriptionsList", + "documentation":"

A list of subscriptions.

" + }, + "NextToken":{ + "shape":"nextToken", + "documentation":"

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

" + } + }, + "documentation":"

Response for ListSubscriptionsByTopic action.

" + }, + "ListSubscriptionsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"nextToken", + "documentation":"

Token returned by the previous ListSubscriptions request.

" + } + }, + "documentation":"Input for ListSubscriptions action." + }, + "ListSubscriptionsResponse":{ + "type":"structure", + "members":{ + "Subscriptions":{ + "shape":"SubscriptionsList", + "documentation":"

A list of subscriptions.

" + }, + "NextToken":{ + "shape":"nextToken", + "documentation":"

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

" + } + }, + "documentation":"

Response for ListSubscriptions action

" + }, + "ListTopicsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"nextToken", + "documentation":"

Token returned by the previous ListTopics request.

" + } + } + }, + "ListTopicsResponse":{ + "type":"structure", + "members":{ + "Topics":{ + "shape":"TopicsList", + "documentation":"

A list of topic ARNs.

" + }, + "NextToken":{ + "shape":"nextToken", + "documentation":"

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

" + } + }, + "documentation":"

Response for ListTopics action.

" + }, + "MapStringToString":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "MessageAttributeMap":{ + "type":"map", + "key":{ + "shape":"String", + "locationName":"Name" + }, + "value":{ + "shape":"MessageAttributeValue", + "locationName":"Value" + } + }, + "MessageAttributeValue":{ + "type":"structure", + "required":["DataType"], + "members":{ + "DataType":{ + "shape":"String", + "documentation":"

Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.

" + }, + "StringValue":{ + "shape":"String", + "documentation":"

Strings are Unicode with UTF8 binary encoding. \n For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

" + }, + "BinaryValue":{ + "shape":"Binary", + "documentation":"

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

" + } + }, + "documentation":"

The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. \n For more information, see Publish.

\n

Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. \n All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).\n For more information, see Using Amazon SNS Message Attributes.

" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the requested resource does not exist.

" + }, + "PlatformApplication":{ + "type":"structure", + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

PlatformApplicationArn for platform application object.

" + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

Attributes for platform application object.

" + } + }, + "documentation":"

Platform application object.

" + }, + "PlatformApplicationDisabledException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

Message for platform application disabled.

" + } + }, + "error":{ + "code":"PlatformApplicationDisabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Exception error indicating platform application disabled.

" + }, + "PublishInput":{ + "type":"structure", + "required":["Message"], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The topic you want to publish to.

" + }, + "TargetArn":{ + "shape":"String", + "documentation":"

Either TopicArn or EndpointArn, but not both.

" + }, + "Message":{ + "shape":"message", + "documentation":"

The message you want to send to the topic.

\n

If you want to send the same message to all transport protocols,\n include the text of the message as a String value.

\n

If you want to send different messages for each transport protocol,\n set the value of the MessageStructure parameter to json\n and use a JSON object for the Message parameter.\n See the Examples section for the format of the JSON object.

\n

Constraints: Messages must be UTF-8 encoded\n strings at most 256 KB in size (262144 bytes, not 262144 characters).

\n

JSON-specific constraints:\n

\n

" + }, + "Subject":{ + "shape":"subject", + "documentation":"

Optional parameter to be used as the \"Subject\" line when the message is\n delivered to email endpoints. This field will also be included, if present, \n in the standard JSON messages delivered to other endpoints.

\n

Constraints: Subjects must be ASCII text that begins with a letter, number, \n or punctuation mark; must not include line breaks or control characters; and \n must be less than 100 characters long.

" + }, + "MessageStructure":{ + "shape":"messageStructure", + "documentation":"

Set MessageStructure to json if you want to send\n a different message for each protocol. For example, using one publish action,\n you can send a short message to your SMS subscribers and a longer message to\n your email subscribers.\n If you set MessageStructure to json, the value of \n the Message parameter must:\n

\n \n

You can define other top-level keys that define the message you want to send\n to a specific transport protocol (e.g., \"http\").

\n

For information about sending different messages for each protocol using\n the AWS Management Console, go to Create \n Different Messages for Each Protocol in the Amazon Simple Notification Service\n Getting Started Guide.\n

\n\n

Valid value: json

" + }, + "MessageAttributes":{ + "shape":"MessageAttributeMap", + "documentation":"

Message attributes for Publish action.

" + } + }, + "documentation":"

Input for Publish action.

" + }, + "PublishResponse":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"messageId", + "documentation":"

Unique identifier assigned to the published message.

\n

Length Constraint: Maximum 100 characters

" + } + }, + "documentation":"

Response for Publish action.

" + }, + "RemovePermissionInput":{ + "type":"structure", + "required":[ + "TopicArn", + "Label" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the topic whose access control policy you wish to modify.

" + }, + "Label":{ + "shape":"label", + "documentation":"

The unique label of the statement you want to remove.

" + } + }, + "documentation":"

Input for RemovePermission action.

" + }, + "SetEndpointAttributesInput":{ + "type":"structure", + "required":[ + "EndpointArn", + "Attributes" + ], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

EndpointArn used for SetEndpointAttributes action.

" + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

A map of the endpoint attributes. Attributes in this map include the following:

\n " + } + }, + "documentation":"

Input for SetEndpointAttributes action.

" + }, + "SetPlatformApplicationAttributesInput":{ + "type":"structure", + "required":[ + "PlatformApplicationArn", + "Attributes" + ], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

PlatformApplicationArn for SetPlatformApplicationAttributes action.

" + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

A map of the platform application attributes. Attributes in this map include the following:

\n " + } + }, + "documentation":"

Input for SetPlatformApplicationAttributes action.

" + }, + "SetSubscriptionAttributesInput":{ + "type":"structure", + "required":[ + "SubscriptionArn", + "AttributeName" + ], + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

The ARN of the subscription to modify.

" + }, + "AttributeName":{ + "shape":"attributeName", + "documentation":"

The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.

\n

Valid values: DeliveryPolicy | RawMessageDelivery

" + }, + "AttributeValue":{ + "shape":"attributeValue", + "documentation":"

The new value for the attribute in JSON format.

" + } + }, + "documentation":"

Input for SetSubscriptionAttributes action.

" + }, + "SetTopicAttributesInput":{ + "type":"structure", + "required":[ + "TopicArn", + "AttributeName" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the topic to modify.

" + }, + "AttributeName":{ + "shape":"attributeName", + "documentation":"

The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.

\n

Valid values: Policy | DisplayName | DeliveryPolicy

" + }, + "AttributeValue":{ + "shape":"attributeValue", + "documentation":"

The new value for the attribute.

" + } + }, + "documentation":"

Input for SetTopicAttributes action.

" + }, + "String":{"type":"string"}, + "SubscribeInput":{ + "type":"structure", + "required":[ + "TopicArn", + "Protocol" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the topic you want to subscribe to.

" + }, + "Protocol":{ + "shape":"protocol", + "documentation":"

The protocol you want to use. Supported protocols include:

\n " + }, + "Endpoint":{ + "shape":"endpoint", + "documentation":"

The endpoint that you want to receive notifications. Endpoints vary by protocol:

\n " + } + }, + "documentation":"Input for Subscribe action." + }, + "SubscribeResponse":{ + "type":"structure", + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

The ARN of the subscription, if the service was able to create a \n subscription immediately (without requiring endpoint owner confirmation).

" + } + }, + "documentation":"Response for Subscribe action." + }, + "Subscription":{ + "type":"structure", + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

The subscription's ARN.

" + }, + "Owner":{ + "shape":"account", + "documentation":"

The subscription's owner.

" + }, + "Protocol":{ + "shape":"protocol", + "documentation":"

The subscription's protocol.

" + }, + "Endpoint":{ + "shape":"endpoint", + "documentation":"

The subscription's endpoint (format depends on the protocol).

" + }, + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The ARN of the subscription's topic.

" + } + }, + "documentation":"

A wrapper type for the attributes of an Amazon SNS subscription.

" + }, + "SubscriptionAttributesMap":{ + "type":"map", + "key":{"shape":"attributeName"}, + "value":{"shape":"attributeValue"} + }, + "SubscriptionLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "error":{ + "code":"SubscriptionLimitExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the customer already owns the maximum allowed number of subscriptions.

" + }, + "SubscriptionsList":{ + "type":"list", + "member":{"shape":"Subscription"} + }, + "Topic":{ + "type":"structure", + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

The topic's ARN.

" + } + }, + "documentation":"

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.

" + }, + "TopicAttributesMap":{ + "type":"map", + "key":{"shape":"attributeName"}, + "value":{"shape":"attributeValue"} + }, + "TopicLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "error":{ + "code":"TopicLimitExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

Indicates that the customer already owns the maximum allowed number of topics.

" + }, + "TopicsList":{ + "type":"list", + "member":{"shape":"Topic"} + }, + "UnsubscribeInput":{ + "type":"structure", + "required":["SubscriptionArn"], + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

The ARN of the subscription to be deleted.

" + } + }, + "documentation":"

Input for Unsubscribe action.

" + }, + "account":{"type":"string"}, + "action":{"type":"string"}, + "attributeName":{"type":"string"}, + "attributeValue":{"type":"string"}, + "authenticateOnUnsubscribe":{"type":"string"}, + "delegate":{"type":"string"}, + "endpoint":{"type":"string"}, + "label":{"type":"string"}, + "message":{"type":"string"}, + "messageId":{"type":"string"}, + "messageStructure":{"type":"string"}, + "nextToken":{"type":"string"}, + "protocol":{"type":"string"}, + "string":{"type":"string"}, + "subject":{"type":"string"}, + "subscriptionARN":{"type":"string"}, + "token":{"type":"string"}, + "topicARN":{"type":"string"}, + "topicName":{"type":"string"} + } +} diff --git a/apis/sns-2010-03-31.paginators.json b/apis/sns-2010-03-31.paginators.json new file mode 100644 index 0000000000..455e4708ec --- /dev/null +++ b/apis/sns-2010-03-31.paginators.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "ListEndpointsByPlatformApplication": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Endpoints" + }, + "ListPlatformApplications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "PlatformApplications" + }, + "ListSubscriptions": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Subscriptions" + }, + "ListSubscriptionsByTopic": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Subscriptions" + }, + "ListTopics": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Topics" + } + } +} diff --git a/apis/sqs-2012-11-05.api.json b/apis/sqs-2012-11-05.api.json new file mode 100644 index 0000000000..01c9d91ec9 --- /dev/null +++ b/apis/sqs-2012-11-05.api.json @@ -0,0 +1,571 @@ +{ + "metadata": { + "apiVersion": "2012-11-05", + "endpointPrefix": "sqs", + "serviceAbbreviation": "Amazon SQS", + "serviceFullName": "Amazon Simple Queue Service", + "signatureVersion": "v4", + "xmlNamespace": "http://queue.amazonaws.com/doc/2012-11-05/", + "protocol": "query" + }, + "operations": { + "AddPermission": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Label", + "AWSAccountIds", + "Actions" + ], + "members": { + "QueueUrl": {}, + "Label": {}, + "AWSAccountIds": { + "type": "list", + "member": { + "locationName": "AWSAccountId" + }, + "flattened": true + }, + "Actions": { + "type": "list", + "member": { + "locationName": "ActionName" + }, + "flattened": true + } + } + } + }, + "ChangeMessageVisibility": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "ReceiptHandle", + "VisibilityTimeout" + ], + "members": { + "QueueUrl": {}, + "ReceiptHandle": {}, + "VisibilityTimeout": { + "type": "integer" + } + } + } + }, + "ChangeMessageVisibilityBatch": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Entries" + ], + "members": { + "QueueUrl": {}, + "Entries": { + "type": "list", + "member": { + "locationName": "ChangeMessageVisibilityBatchRequestEntry", + "type": "structure", + "required": [ + "Id", + "ReceiptHandle" + ], + "members": { + "Id": {}, + "ReceiptHandle": {}, + "VisibilityTimeout": { + "type": "integer" + } + } + }, + "flattened": true + } + } + }, + "output": { + "resultWrapper": "ChangeMessageVisibilityBatchResult", + "type": "structure", + "required": [ + "Successful", + "Failed" + ], + "members": { + "Successful": { + "type": "list", + "member": { + "locationName": "ChangeMessageVisibilityBatchResultEntry", + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "flattened": true + }, + "Failed": { + "shape": "Sd" + } + } + } + }, + "CreateQueue": { + "input": { + "type": "structure", + "required": [ + "QueueName" + ], + "members": { + "QueueName": {}, + "Attributes": { + "shape": "Sh", + "locationName": "Attribute" + } + } + }, + "output": { + "resultWrapper": "CreateQueueResult", + "type": "structure", + "members": { + "QueueUrl": {} + } + } + }, + "DeleteMessage": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "ReceiptHandle" + ], + "members": { + "QueueUrl": {}, + "ReceiptHandle": {} + } + } + }, + "DeleteMessageBatch": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Entries" + ], + "members": { + "QueueUrl": {}, + "Entries": { + "type": "list", + "member": { + "locationName": "DeleteMessageBatchRequestEntry", + "type": "structure", + "required": [ + "Id", + "ReceiptHandle" + ], + "members": { + "Id": {}, + "ReceiptHandle": {} + } + }, + "flattened": true + } + } + }, + "output": { + "resultWrapper": "DeleteMessageBatchResult", + "type": "structure", + "required": [ + "Successful", + "Failed" + ], + "members": { + "Successful": { + "type": "list", + "member": { + "locationName": "DeleteMessageBatchResultEntry", + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "flattened": true + }, + "Failed": { + "shape": "Sd" + } + } + } + }, + "DeleteQueue": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {} + } + } + }, + "GetQueueAttributes": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {}, + "AttributeNames": { + "shape": "St" + } + } + }, + "output": { + "resultWrapper": "GetQueueAttributesResult", + "type": "structure", + "members": { + "Attributes": { + "shape": "Sh", + "locationName": "Attribute" + } + } + } + }, + "GetQueueUrl": { + "input": { + "type": "structure", + "required": [ + "QueueName" + ], + "members": { + "QueueName": {}, + "QueueOwnerAWSAccountId": {} + } + }, + "output": { + "resultWrapper": "GetQueueUrlResult", + "type": "structure", + "members": { + "QueueUrl": {} + } + } + }, + "ListDeadLetterSourceQueues": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {} + } + }, + "output": { + "resultWrapper": "ListDeadLetterSourceQueuesResult", + "type": "structure", + "required": [ + "queueUrls" + ], + "members": { + "queueUrls": { + "shape": "Sz" + } + } + } + }, + "ListQueues": { + "input": { + "type": "structure", + "members": { + "QueueNamePrefix": {} + } + }, + "output": { + "resultWrapper": "ListQueuesResult", + "type": "structure", + "members": { + "QueueUrls": { + "shape": "Sz" + } + } + } + }, + "ReceiveMessage": { + "input": { + "type": "structure", + "required": [ + "QueueUrl" + ], + "members": { + "QueueUrl": {}, + "AttributeNames": { + "shape": "St" + }, + "MessageAttributeNames": { + "type": "list", + "member": { + "locationName": "MessageAttributeName" + }, + "flattened": true + }, + "MaxNumberOfMessages": { + "type": "integer" + }, + "VisibilityTimeout": { + "type": "integer" + }, + "WaitTimeSeconds": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "ReceiveMessageResult", + "type": "structure", + "members": { + "Messages": { + "type": "list", + "member": { + "locationName": "Message", + "type": "structure", + "members": { + "MessageId": {}, + "ReceiptHandle": {}, + "MD5OfBody": {}, + "Body": {}, + "Attributes": { + "shape": "Sh", + "locationName": "Attribute" + }, + "MD5OfMessageAttributes": {}, + "MessageAttributes": { + "shape": "S18", + "locationName": "MessageAttribute" + } + } + }, + "flattened": true + } + } + } + }, + "RemovePermission": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Label" + ], + "members": { + "QueueUrl": {}, + "Label": {} + } + } + }, + "SendMessage": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "MessageBody" + ], + "members": { + "QueueUrl": {}, + "MessageBody": {}, + "DelaySeconds": { + "type": "integer" + }, + "MessageAttributes": { + "shape": "S18", + "locationName": "MessageAttribute" + } + } + }, + "output": { + "resultWrapper": "SendMessageResult", + "type": "structure", + "members": { + "MD5OfMessageBody": {}, + "MD5OfMessageAttributes": {}, + "MessageId": {} + } + } + }, + "SendMessageBatch": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Entries" + ], + "members": { + "QueueUrl": {}, + "Entries": { + "type": "list", + "member": { + "locationName": "SendMessageBatchRequestEntry", + "type": "structure", + "required": [ + "Id", + "MessageBody" + ], + "members": { + "Id": {}, + "MessageBody": {}, + "DelaySeconds": { + "type": "integer" + }, + "MessageAttributes": { + "shape": "S18", + "locationName": "MessageAttribute" + } + } + }, + "flattened": true + } + } + }, + "output": { + "resultWrapper": "SendMessageBatchResult", + "type": "structure", + "required": [ + "Successful", + "Failed" + ], + "members": { + "Successful": { + "type": "list", + "member": { + "locationName": "SendMessageBatchResultEntry", + "type": "structure", + "required": [ + "Id", + "MessageId", + "MD5OfMessageBody" + ], + "members": { + "Id": {}, + "MessageId": {}, + "MD5OfMessageBody": {}, + "MD5OfMessageAttributes": {} + } + }, + "flattened": true + }, + "Failed": { + "shape": "Sd" + } + } + } + }, + "SetQueueAttributes": { + "input": { + "type": "structure", + "required": [ + "QueueUrl", + "Attributes" + ], + "members": { + "QueueUrl": {}, + "Attributes": { + "shape": "Sh", + "locationName": "Attribute" + } + } + } + } + }, + "shapes": { + "Sd": { + "type": "list", + "member": { + "locationName": "BatchResultErrorEntry", + "type": "structure", + "required": [ + "Id", + "SenderFault", + "Code" + ], + "members": { + "Id": {}, + "SenderFault": { + "type": "boolean" + }, + "Code": {}, + "Message": {} + } + }, + "flattened": true + }, + "Sh": { + "type": "map", + "key": { + "locationName": "Name" + }, + "value": { + "locationName": "Value" + }, + "flattened": true, + "locationName": "Attribute" + }, + "St": { + "type": "list", + "member": { + "locationName": "AttributeName" + }, + "flattened": true + }, + "Sz": { + "type": "list", + "member": { + "locationName": "QueueUrl" + }, + "flattened": true + }, + "S18": { + "type": "map", + "key": { + "locationName": "Name" + }, + "value": { + "locationName": "Value", + "type": "structure", + "required": [ + "DataType" + ], + "members": { + "StringValue": {}, + "BinaryValue": { + "type": "blob" + }, + "StringListValues": { + "flattened": true, + "locationName": "StringListValue", + "type": "list", + "member": { + "locationName": "StringListValue" + } + }, + "BinaryListValues": { + "flattened": true, + "locationName": "BinaryListValue", + "type": "list", + "member": { + "locationName": "BinaryListValue", + "type": "blob" + } + }, + "DataType": {} + } + }, + "flattened": true + } + } +} \ No newline at end of file diff --git a/apis/sqs-2012-11-05.full.json b/apis/sqs-2012-11-05.full.json new file mode 100644 index 0000000000..989daaf7b4 --- /dev/null +++ b/apis/sqs-2012-11-05.full.json @@ -0,0 +1,1438 @@ +{ + "metadata":{ + "apiVersion":"2012-11-05", + "endpointPrefix":"sqs", + "serviceAbbreviation":"Amazon SQS", + "serviceFullName":"Amazon Simple Queue Service", + "signatureVersion":"v4", + "xmlNamespace":"http://queue.amazonaws.com/doc/2012-11-05/", + "protocol":"query" + }, + "documentation":"

Welcome to the Amazon Simple Queue Service API Reference. This section\n describes who should read this guide, how the guide is organized, and other resources related to the\n Amazon Simple Queue Service (Amazon SQS).

\n

Amazon SQS offers reliable and scalable hosted queues for storing messages as they travel\n between computers. By using Amazon SQS, you can move data between distributed components of\n your applications that perform different tasks without losing messages or requiring each\n component to be always available.

\n

Helpful Links:\n

\n

\n

We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. \n The SDKs contain functionality that automatically takes care of tasks such as:

\n

\n

\n

\n

For a list of available SDKs, go to Tools for Amazon Web Services.

", + "operations":{ + "AddPermission":{ + "name":"AddPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddPermissionRequest"}, + "errors":[ + { + "shape":"OverLimit", + "error":{ + "code":"OverLimit", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The action that you requested would violate a limit. For example,\n ReceiveMessage returns this error if the maximum number of messages\n inflight has already been reached. AddPermission returns this error if\n the maximum number of permissions for the queue has already been reached.\n

" + } + ], + "documentation":"

Adds a permission to a queue for a specific \n principal.\n This allows for sharing access to the queue.

\n\n

When you create a queue, you have full control access rights for the queue.\n Only you (as owner of the queue) can grant or deny permissions to the queue.\n For more information about these permissions, see\n Shared\n Queues in the Amazon SQS Developer Guide.

\n\n \n

AddPermission writes an Amazon SQS-generated policy. If you want to\n write your own policy, use SetQueueAttributes to upload your policy. For more\n information about writing your own policy, see\n Using\n The Access Policy Language in the Amazon SQS Developer Guide.

\n \n \n Some API actions take lists of parameters. These lists are specified using the param.n notation. Values\n of n are integers starting from 1. For example, a parameter list with two elements looks like this: \n \n

&Attribute.1=this

\n

&Attribute.2=that

\n \n \n \n The following example Query request grants a SendMessage permission to the principal whose AWS account number is 125074342641.\n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=AddPermission\n&Label=testLabel\n&AWSAccountId.1=125074342641\n&ActionName.1=SendMessage\n&AWSAccountId.2=125074342642\n&ActionName.2=ReceiveMessage\n&Version=2009-02-01\n&SignatureMethod=HmacSHA256\n&Expires=2009-04-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n 9a285199-c8d6-47c2-bdb2-314cb47d599d\n \n \n\n\n \n \n " + }, + "ChangeMessageVisibility":{ + "name":"ChangeMessageVisibility", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangeMessageVisibilityRequest"}, + "errors":[ + { + "shape":"MessageNotInflight", + "error":{ + "code":"AWS.SimpleQueueService.MessageNotInflight", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The message referred to is not in flight.

" + }, + { + "shape":"ReceiptHandleIsInvalid", + "exception":true, + "documentation":"

The receipt handle provided is not valid.

" + } + ], + "documentation":"

Changes the visibility\n timeout of a specified message in a queue to a new value. The maximum allowed\n timeout value you can set the value to is 12 hours. This means you can't extend\n the timeout of a message in an existing queue to more than a total visibility\n timeout of 12 hours. (For more information visibility timeout, see Visibility\n Timeout in the Amazon SQS Developer Guide.)

\n\n

For example, let's say you have a message and its default message visibility\n timeout is 30 minutes. You could call ChangeMessageVisiblity with\n a value of two hours and the effective timeout would be two hours and 30\n minutes. When that time comes near you could again extend the time out by\n calling ChangeMessageVisiblity, but this time the maximum allowed timeout would\n be 9 hours and 30 minutes.

\n \n

There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should \n delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.\n

\n\n If you attempt to set the VisibilityTimeout to an\n amount more than the maximum time left, Amazon SQS returns an error. It will\n not automatically recalculate and increase the timeout to the maximum time\n remaining.\n\n Unlike with a queue, when you change the visibility timeout for a\n specific message, that timeout value is applied immediately but is not saved in\n memory for that message. If you don't delete a message after it is received,\n the visibility timeout for the message the next time it is received reverts to\n the original timeout value, not the value you set with the\n ChangeMessageVisibility action.\n \n \n \n The following example Query request changes the visibility timeout for a message to 60 seconds.\n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=ChangeMessageVisibility\n&VisibilityTimeout=60\n&ReceiptHandle=MbZj6wDWli%2BJvwwJaBV%2B3dcjk2YW2vA3%2BSTFFljT\nM8tJJg6HRG6PYSasuWXPJB%2BCwLj1FjgXUv1uSj1gUPAWV66FU/WeR4mq2OKpEGY\nWbnLmpRCJVAyeMjeU5ZBdtcQ%2BQEauMZc8ZRv37sIW2iJKq3M9MFx1YvV11A2x/K\nSbkJ0=\n&Version=2009-02-01\n&SignatureMethod=HmacSHA256\n&Expires=2009-04-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n 6a7a282a-d013-4a59-aba9-335b0fa48bed\n \n \n\n\n \n \n " + }, + "ChangeMessageVisibilityBatch":{ + "name":"ChangeMessageVisibilityBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangeMessageVisibilityBatchRequest"}, + "output":{ + "shape":"ChangeMessageVisibilityBatchResult", + "documentation":"

\n For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or \n a BatchResultErrorEntry tag if the message fails.\n

", + "resultWrapper":"ChangeMessageVisibilityBatchResult" + }, + "errors":[ + { + "shape":"TooManyEntriesInBatchRequest", + "error":{ + "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Batch request contains more number of entries than permissible.

" + }, + { + "shape":"EmptyBatchRequest", + "error":{ + "code":"AWS.SimpleQueueService.EmptyBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Batch request does not contain an entry.

" + }, + { + "shape":"BatchEntryIdsNotDistinct", + "error":{ + "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more batch entries have the same Id in the request.

" + }, + { + "shape":"InvalidBatchEntryId", + "error":{ + "code":"AWS.SimpleQueueService.InvalidBatchEntryId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The Id of a batch entry in a batch request does not abide\n by the specification.

" + } + ], + "documentation":"

Changes the visibility timeout of multiple messages.\n This is a batch version of ChangeMessageVisibility. The\n result of the action on each message is reported individually in the\n response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

\n Because the batch request can result in a combination of successful and unsuccessful actions, \n you should check for batch errors even when the call returns an HTTP status code of 200.\n Some API actions take lists of parameters. These lists are specified using the param.n notation. Values\n of n are integers starting from 1. For example, a parameter list with two elements looks like this: \n \n

&Attribute.1=this

\n

&Attribute.2=that

\n \n \n \n ChangeMessageVisibilityBatch request changes the visibility timeout settings for two messages. \n You must URL encode the entire URL; however, we've URL encoded\n only the message body to make the example easier for you to read.\n \n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n&Action=ChangeMessageVisibilityBatch\n&Version=2011-10-01\n&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2\n&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=gfk0T0R0waama4fVFffkjKzmhMCymjQvfTFk2LxT33G4ms5subrE0deLKWSscPU1oD3J9zgeS4PQQ3U30qOumIE6AdAv3w%2F%2Fa1IXW6AqaWhGsEPaLm3Vf6IiWqdM8u5imB%2BNTwj3tQRzOWdTOePjOjPcTpRxBtXix%2BEvwJOZUma9wabv%2BSw6ZHjwmNcVDx8dZXJhVp16Bksiox%2FGrUvrVTCJRTWTLc59oHLLF8sEkKzRmGNzTDGTiV%2BYjHfQj60FD3rVaXmzTsoNxRhKJ72uIHVMGVQiAGgBX6HGv9LDmYhPXw4hy%2FNgIg%3D%3D\n&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45\n&ChangeMessageVisibilityBatchRequestEntry.2.Id=change_visibility_msg_3\n&ChangeMessageVisibilityBatchRequestEntry.2.ReceiptHandle=gfk0T0R0waama4fVFffkjKzmhMCymjQvfTFk2LxT33FUgBz3%2BnougdeLKWSscPU1%2FXgx%2BxcNnjnQQ3U30qOumIE6AdAv3w%2F%2Fa1IXW6AqaWhGsEPaLm3Vf6IiWqdM8u5imB%2BNTwj3tQRzOWdTOePjOsogjZM%2F7kzn4Ew27XLU9I%2FYaWYmKvDbq%2Fk3HKVB9HfB43kE49atP2aWrzNL4yunG41Q4cfRRtfJdcGQGNHQ2%2Byd0Usf5qR1dZr1iDo5xk946eQat83AxTRP%2BY4Qi0V7FAeSLH9su9xpX6HGv9LDmYhPXw4hy%2FNgIg%3D%3D\n&ChangeMessageVisibilityBatchRequestEntry.2.VisibilityTimeout=45\n&SignatureMethod=HmacSHA256\n&Expires=2011-10-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n change_visibility_msg_2\n \n \n change_visibility_msg_3\n \n \n \n ca9668f7-ab1b-4f7a-8859-f15747ab17a7\n \n\n\n \n \n " + }, + "CreateQueue":{ + "name":"CreateQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateQueueRequest"}, + "output":{ + "shape":"CreateQueueResult", + "documentation":"

Returns the QueueUrl element of the created queue.

", + "resultWrapper":"CreateQueueResult" + }, + "errors":[ + { + "shape":"QueueDeletedRecently", + "error":{ + "code":"AWS.SimpleQueueService.QueueDeletedRecently", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You must wait 60 seconds after deleting a queue before you can create another\n with the same name.

" + }, + { + "shape":"QueueNameExists", + "error":{ + "code":"QueueAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A queue already exists with this name. Amazon SQS returns this error only if the request includes\n attributes whose values differ from those of the existing queue.

" + } + ], + "documentation":"

Creates a new queue, or returns the URL\n of an existing one. When you request CreateQueue, you provide a\n name for the queue. To successfully create a new queue, you must provide a name\n that is unique within the scope of your own queues.

\n \n \n

If you delete a queue, you must wait at least 60 seconds before creating a queue with the\n same name.

\n \n\n

You may pass one or more attributes in the request. If you do not\n provide a value for any attribute, the queue will have the default value\n for that attribute. Permitted attributes are the same that can be set\n using SetQueueAttributes.

\n \n

Use GetQueueUrl to get a queue's URL.\n GetQueueUrl requires only the QueueName parameter.

 \n\n

If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes,\n CreateQueue returns the queue URL for the existing queue. If the queue name, attribute names, \n or attribute values do not match an existing queue, CreateQueue returns an error.

\n \n Some API actions take lists of parameters. These lists are specified using the param.n notation. Values\n of n are integers starting from 1. For example, a parameter list with two elements looks like this: \n \n

&Attribute.1=this

\n

&Attribute.2=that

\n \n \n \n The following example Query request creates a new queue named testQueue.\n \n \nhttp://sqs.us-east-1.amazonaws.com/\n?Action=CreateQueue\n&QueueName=testQueue\n&Attribute.1.Name=VisibilityTimeout\n&Attribute.1.Value=40\n&Version=2011-10-01\n&SignatureMethod=HmacSHA256\n&Expires=2011-10-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n http://&useast1-query;/123456789012/testQueue\n \n \n \n \n 7a62c49f-347e-4fc4-9331-6e8e7a96aa73\n \n \n\n\n \n \n " + }, + "DeleteMessage":{ + "name":"DeleteMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMessageRequest"}, + "errors":[ + { + "shape":"InvalidIdFormat", + "exception":true, + "documentation":"

The receipt handle is not valid for the current version.

" + }, + { + "shape":"ReceiptHandleIsInvalid", + "exception":true, + "documentation":"

The receipt handle provided is not valid.

" + } + ], + "documentation":"

\n Deletes the specified message from the specified\n queue. You specify the message by using the message's receipt\n handle and not the message ID you received when you\n sent the message. Even if the message is locked by another reader due to the visibility\n timeout setting, it is still deleted from the queue. If you leave a message in the queue\n for longer than the queue's configured retention period, Amazon SQS automatically deletes\n it. \n

\n \n

\n The receipt handle is associated with a specific instance of receiving the message. If\n you receive a message more than once, the receipt handle you get each time you receive the\n message is different. When you request DeleteMessage, if you don't\n provide the most recently received receipt handle for the message, the request will still\n succeed, but the message might not be deleted.\n

\n \n \n

\n It is possible you will receive a message even after you have deleted it. This might\n happen on rare occasions if one of the servers storing a copy of the message is unavailable\n when you request to delete the message. The copy remains on the server and might be returned\n to you again on a subsequent receive request. You should create your system to be idempotent\n so that receiving a particular message more than once is not a problem.\n

\n \n \n \n The following example Query request deletes a message from the queue named testQueue.\n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=DeleteMessage\n&ReceiptHandle=MbZj6wDWli%2BJvwwJaBV%2B3dcjk2YW2vA3%2BSTFFljT\nM8tJJg6HRG6PYSasuWXPJB%2BCwLj1FjgXUv1uSj1gUPAWV66FU/WeR4mq2OKpEGY\nWbnLmpRCJVAyeMjeU5ZBdtcQ%2BQEauMZc8ZRv37sIW2iJKq3M9MFx1YvV11A2x/K\nSbkJ0=\n&Version=2009-02-01\n&SignatureMethod=HmacSHA256\n&Expires=2009-04-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n b5293cb5-d306-4a17-9048-b263635abe42\n \n \n\n\n \n \n " + }, + "DeleteMessageBatch":{ + "name":"DeleteMessageBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMessageBatchRequest"}, + "output":{ + "shape":"DeleteMessageBatchResult", + "documentation":"

\n For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry tag if the message is deleted or \n a BatchResultErrorEntry tag if the message cannot be deleted.\n

", + "resultWrapper":"DeleteMessageBatchResult" + }, + "errors":[ + { + "shape":"TooManyEntriesInBatchRequest", + "error":{ + "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Batch request contains more number of entries than permissible.

" + }, + { + "shape":"EmptyBatchRequest", + "error":{ + "code":"AWS.SimpleQueueService.EmptyBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Batch request does not contain an entry.

" + }, + { + "shape":"BatchEntryIdsNotDistinct", + "error":{ + "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more batch entries have the same Id in the request.

" + }, + { + "shape":"InvalidBatchEntryId", + "error":{ + "code":"AWS.SimpleQueueService.InvalidBatchEntryId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The Id of a batch entry in a batch request does not abide\n by the specification.

" + } + ], + "documentation":"

Deletes multiple messages.\n This is a batch version of DeleteMessage. The result of the delete\n action on each message is reported individually in the response.

\n \n

\n Because the batch request can result in a combination of successful and unsuccessful actions, \n you should check for batch errors even when the call returns an HTTP status code of 200.\n

\n \n Some API actions take lists of parameters. These lists are specified using the param.n notation. Values\n of n are integers starting from 1. For example, a parameter list with two elements looks like this: \n \n

&Attribute.1=this

\n

&Attribute.2=that

\n \n \n \n The following example DeleteMessageBatch request deletes two messages. You must URL encode the entire URL; however, we've URL encoded\n only the message body to make the example easier for you to read.\n \n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n&Action=DeleteMessageBatch\n&Version=2011-10-01\n&DeleteMessageBatchRequestEntry.1.Id=msg1\n&DeleteMessageBatchRequestEntry.1.ReceiptHandle=gfk0T0R0waama4fVFffkjPQrrvzMrOg0fTFk2LxT33EuB8wR0ZCFgKWyXGWFoqqpCIiprQUEhir%2F5LeGPpYTLzjqLQxyQYaQALeSNHb0us3uE84uujxpBhsDkZUQkjFFkNqBXn48xlMcVhTcI3YLH%2Bd%2BIqetIOHgBCZAPx6r%2B09dWaBXei6nbK5Ygih21DCDdAwFV68Jo8DXhb3ErEfoDqx7vyvC5nCpdwqv%2BJhU%2FTNGjNN8t51v5c%2FAXvQsAzyZVNapxUrHIt4NxRhKJ72uICcxruyE8eRXlxIVNgeNP8ZEDcw7zZU1Zw%3D%3D\n&DeleteMessageBatchRequestEntry.2.Id=msg2\n&DeleteMessageBatchRequestEntry.2.ReceiptHandle=gfk0T0R0waama4fVFffkjKzmhMCymjQvfTFk2LxT33G4ms5subrE0deLKWSscPU1oD3J9zgeS4PQQ3U30qOumIE6AdAv3w%2F%2Fa1IXW6AqaWhGsEPaLm3Vf6IiWqdM8u5imB%2BNTwj3tQRzOWdTOePjOjPcTpRxBtXix%2BEvwJOZUma9wabv%2BSw6ZHjwmNcVDx8dZXJhVp16Bksiox%2FGrUvrVTCJRTWTLc59oHLLF8sEkKzRmGNzTDGTiV%2BYjHfQj60FD3rVaXmzTsoNxRhKJ72uIHVMGVQiAGgB%2BqAbSqfKHDQtVOmJJgkHug%3D%3D\n&SignatureMethod=HmacSHA256\n&Expires=2011-10-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n msg1\n \n \n msg2\n \n \n \n d6f86b7a-74d1-4439-b43f-196a1e29cd85\n \n\n\n \n \n " + }, + "DeleteQueue":{ + "name":"DeleteQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteQueueRequest"}, + "documentation":"

\n Deletes the queue specified by the queue\n URL, regardless of whether the queue is empty. If the specified queue does not\n exist, Amazon SQS returns a successful response.\n

\n \n

\n Use DeleteQueue with care; once you delete your queue, any messages\n in the queue are no longer available.\n

\n \n

\n When you delete a queue, the deletion process takes up to 60 seconds. Requests you send\n involving that queue during the 60 seconds might succeed. For example, a\n SendMessage request might succeed, but after the 60 seconds, the queue and\n that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60\n seconds before creating a queue with the same name.\n

\n

\n We reserve the right to delete queues that have had no activity for more than 30 days. For more\n information, see \n How\n Amazon SQS Queues Work in the Amazon SQS Developer Guide.\n

\n \n \n The following example Query request deletes the specified queue.\n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=DeleteQueue\n&Version=2009-02-01\n&SignatureMethod=HmacSHA256\n&Expires=2009-04-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n 6fde8d1e-52cd-4581-8cd9-c512f4c64223\n \n \n\n\n \n \n " + }, + "GetQueueAttributes":{ + "name":"GetQueueAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueueAttributesRequest"}, + "output":{ + "shape":"GetQueueAttributesResult", + "documentation":"A list of returned queue attributes.", + "resultWrapper":"GetQueueAttributesResult" + }, + "errors":[ + { + "shape":"InvalidAttributeName", + "exception":true, + "documentation":"

The attribute referred to does not exist.

" + } + ], + "documentation":"

Gets attributes for the specified queue. The following attributes are supported:\n

\n

\n Going forward, new attributes might be added. \n If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.\n Some API actions take lists of parameters. These lists are specified using the param.n notation. Values\n of n are integers starting from 1. For example, a parameter list with two elements looks like this: \n \n

&Attribute.1=this

\n

&Attribute.2=that

\n \n \n \n The following example Query requests gets all the attribute values for the specified queue.\n \n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=GetQueueAttributes\n&AttributeName.1=All\n&Version=2012-11-05\n&SignatureMethod=HmacSHA256\n&Expires=2013-10-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n ReceiveMessageWaitTimeSeconds\n 2\n \n \n VisibilityTimeout\n 30\n \n \n ApproximateNumberOfMessages\n 0\n \n \n ApproximateNumberOfMessagesNotVisible\n 0\n \n \n CreatedTimestamp\n 1286771522\n \n \n LastModifiedTimestamp\n 1286771522\n \n \n QueueArn\n arn:aws:sqs:us-east-1:123456789012:qfoo\n \n \n MaximumMessageSize\n 8192\n \n \n MessageRetentionPeriod\n 345600\n \n \n \n 1ea71be5-b5a2-4f9d-b85a-945d8d08cd0b\n \n\n\n\n \n \n \n \n The following example Query request gets three attribute values for the specified\n queue.\n \n \n\nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=GetQueueAttributes\n&Action=GetQueueAttributes\n&Version=2012-11-05\n&AttributeName.1=VisibilityTimeout\n&AttributeName.2=DelaySeconds\n&AttributeName.3=ReceiveMessageWaitTimeSeconds\n&SignatureMethod=HmacSHA256\n&Expires=2013-10-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n\n\n \n \n VisibilityTimeout\n 30\n \n \n DelaySeconds\n 0\n \n \n ReceiveMessageWaitTimeSeconds\n 2\n \n\n\n \n \n " + }, + "GetQueueUrl":{ + "name":"GetQueueUrl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueueUrlRequest"}, + "output":{ + "shape":"GetQueueUrlResult", + "documentation":"

For more information, see \n Responses\n in the Amazon SQS Developer Guide.

", + "resultWrapper":"GetQueueUrlResult" + }, + "errors":[ + { + "shape":"QueueDoesNotExist", + "error":{ + "code":"AWS.SimpleQueueService.NonExistentQueue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The queue referred to does not exist.

" + } + ], + "documentation":"

\n Returns the URL of an existing queue. \n This action provides a simple way to retrieve the URL of an Amazon SQS queue.\n

\n

\n To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId\n parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to \n access the queue. For more information about shared queue access, see AddPermission or go to\n Shared Queues\n in the Amazon SQS Developer Guide.\n

\n \n \n \n The following example Query request gets the URL for the specified queue.\n \n \nhttp://sqs.us-east-1.amazonaws.com/\n?Action=GetQueueUrl\n&QueueName=testQueue\n&Version=2011-10-01\n&SignatureMethod=HmacSHA256\n&Expires=2011-10-24T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n http://&useast1-query;/123456789012/testQueue\n \n \n \n 470a6f13-2ed9-4181-ad8a-2fdea142988e\n \n\n\n \n \n " + }, + "ListDeadLetterSourceQueues":{ + "name":"ListDeadLetterSourceQueues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeadLetterSourceQueuesRequest"}, + "output":{ + "shape":"ListDeadLetterSourceQueuesResult", + "documentation":"A list of your dead letter source queues.", + "resultWrapper":"ListDeadLetterSourceQueuesResult" + }, + "errors":[ + { + "shape":"QueueDoesNotExist", + "error":{ + "code":"AWS.SimpleQueueService.NonExistentQueue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The queue referred to does not exist.

" + } + ], + "documentation":"

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

\n \n \n \n The following example Query request returns a list of dead letter source queues. In this example only one source queue, MySourceQueue, was configured \n with a dead letter queue.\n \n \nAction=ListDeadLetterSourceQueues\n&Version=2012-11-05\n\n \n \n \n\n \n http://sqs.us-east-1.amazonaws.com/123456789012/MySourceQueue\n \n \n 8ffb921f-b85e-53d9-abcf-d8d0057f38fc\n \n\n\n \n \n \n

For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues.

" + }, + "ListQueues":{ + "name":"ListQueues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListQueuesRequest"}, + "output":{ + "shape":"ListQueuesResult", + "documentation":"A list of your queues.", + "resultWrapper":"ListQueuesResult" + }, + "documentation":"

Returns a list of your queues. The maximum number of\n queues that can be returned is 1000. If you specify a value for the optional\n QueueNamePrefix parameter, only queues with a name beginning with the\n specified value are returned.

\n \n \n \n The following example Query request returns the queues whose names begin with the letter \"T\".\n \n \nhttp://sqs.us-east-1.amazonaws.com/\n?Action=ListQueues\n&QueueNamePrefix=t\n&Version=2009-02-01\n&SignatureMethod=HmacSHA256\n&Expires=2009-04-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n http://sqs.us-east-1.amazonaws.com/123456789012/testQueue\n \n \n \n \n 725275ae-0b9b-4762-b238-436d7c65a1ac\n \n \n\n\n \n \n " + }, + "ReceiveMessage":{ + "name":"ReceiveMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReceiveMessageRequest"}, + "output":{ + "shape":"ReceiveMessageResult", + "documentation":"A list of received messages.", + "resultWrapper":"ReceiveMessageResult" + }, + "errors":[ + { + "shape":"OverLimit", + "error":{ + "code":"OverLimit", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The action that you requested would violate a limit. For example,\n ReceiveMessage returns this error if the maximum number of messages\n inflight has already been reached. AddPermission returns this error if\n the maximum number of permissions for the queue has already been reached.\n

" + } + ], + "documentation":"

\n Retrieves one or more messages, with a maximum limit of 10 messages, from the specified\n queue. Long poll support is enabled by using the WaitTimeSeconds parameter. \n For more information, see \n Amazon SQS Long Poll in the Amazon SQS Developer Guide.\n

\n

\n Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. \n This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), \n it is likely you will get fewer messages than you requested per ReceiveMessage call. \n If the number of messages in the queue is extremely small, you might not receive any messages in\n a particular ReceiveMessage response; in which case you should repeat the\n request.\n

\n

\n For each message returned, the response includes the following:\n

\n \n

\n The receipt handle is the identifier you must provide when deleting the message. For more\n information, see \n Queue\n and Message Identifiers in the Amazon SQS Developer Guide.\n

\n

\n You can provide the VisibilityTimeout parameter in your request, which\n will be applied to the messages that Amazon SQS returns in the response. If you do not include the\n parameter, the overall visibility timeout for the queue is used for the returned messages. For\n more information, see \n Visibility\n Timeout in the Amazon SQS Developer Guide. \n

\n \n

\n Going forward, new attributes might be added. If you are writing code that calls this action,\n we recommend that you structure your code so that it can handle new attributes gracefully.\n

\n \n \n \n \n The following example Query request receives messages from the specified queue.\n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=ReceiveMessage\n&MaxNumberOfMessages=5\n&VisibilityTimeout=15\n&AttributeName=All;\n&Version=2009-02-01\n&SignatureMethod=HmacSHA256\n&Expires=2009-04-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n \n 5fea7756-0ea4-451a-a703-a558b933e274\n \n \n MbZj6wDWli+JvwwJaBV+3dcjk2YW2vA3+STFFljTM8tJJg6HRG6PYSasuWXPJB+Cw\n Lj1FjgXUv1uSj1gUPAWV66FU/WeR4mq2OKpEGYWbnLmpRCJVAyeMjeU5ZBdtcQ+QE\n auMZc8ZRv37sIW2iJKq3M9MFx1YvV11A2x/KSbkJ0=\n \n \n fafb00f5732ab283681e124bf8747ed1\n \n This is a test message\n \n SenderId\n 195004372649\n \n \n SentTimestamp\n 1238099229000\n \n \n ApproximateReceiveCount\n 5\n \n \n ApproximateFirstReceiveTimestamp\n 1250700979248\n \n \n \n \n \n b6633655-283d-45b4-aee4-4e84e0ae6afa\n \n \n\n\n \n \n " + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemovePermissionRequest"}, + "documentation":"

Revokes any permissions in the queue\n policy that matches the specified Label parameter. Only the owner\n of the queue can remove permissions.

\n \n \n \n The following example Query request removes the testLabel permission on the queue named testQueue.\n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=RemovePermission\n&Label=testLabel\n&Version=2009-02-01\n&SignatureMethod=HmacSHA256\n&Expires=2009-04-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n f8bdb362-6616-42c0-977a-ce9a8bcce3bb\n \n \n\n\n \n \n " + }, + "SendMessage":{ + "name":"SendMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMessageRequest"}, + "output":{ + "shape":"SendMessageResult", + "documentation":"

The MD5OfMessageBody and MessageId elements.

", + "resultWrapper":"SendMessageResult" + }, + "errors":[ + { + "shape":"InvalidMessageContents", + "exception":true, + "documentation":"

The message contains characters outside the allowed set.

" + }, + { + "shape":"UnsupportedOperation", + "error":{ + "code":"AWS.SimpleQueueService.UnsupportedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Error code 400. Unsupported operation.

" + } + ], + "documentation":"

\n Delivers a message to the specified\n queue. With Amazon SQS, you now have the ability to send large payload messages that are up\n to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that\n supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK\n release notes.\n

\n \n

\n The following list shows the characters (in Unicode) allowed in your message, according\n to the W3C XML specification. For more information, go to \n http://www.w3.org/TR/REC-xml/#charsets \n If you send any characters not included in the list, your request will be rejected.\n

\n

\n #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]\n

\n \n \n \n \n The following example SendMessage request sends a message containing \"This is a test message\" to the queue. \n You must URL encode the entire URL; however, we've URL encoded only the message body to make the example easier for you to read. \n The following example response includes the MD5 digest for \"This is a test message\".\n \n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=SendMessage\n&MessageBody=This+is+a+test+message\n&MessageAttribute.1.Name=test_attribute_name_1\n&MessageAttribute.1.Value.StringValue=test_attribute_value_1\n&MessageAttribute.1.Value.DataType=String\n&MessageAttribute.2.Name=test_attribute_name_2\n&MessageAttribute.2.Value.StringValue=test_attribute_value_2\n&MessageAttribute.2.Value.DataType=String\n&Version=2012-11-05\n&SignatureMethod=HmacSHA256\n&Expires=2014-05-05T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n fafb00f5732ab283681e124bf8747ed1\n \n \n\t 3ae8f24a165a8cedc005670c81a27295\n \n \n 5fea7756-0ea4-451a-a703-a558b933e274\n \n \n \n \n 27daac76-34dd-47df-bd01-1f6e873584a0\n \n \n\n\n \n \n " + }, + "SendMessageBatch":{ + "name":"SendMessageBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMessageBatchRequest"}, + "output":{ + "shape":"SendMessageBatchResult", + "documentation":"

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

", + "resultWrapper":"SendMessageBatchResult" + }, + "errors":[ + { + "shape":"TooManyEntriesInBatchRequest", + "error":{ + "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Batch request contains more number of entries than permissible.

" + }, + { + "shape":"EmptyBatchRequest", + "error":{ + "code":"AWS.SimpleQueueService.EmptyBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Batch request does not contain an entry.

" + }, + { + "shape":"BatchEntryIdsNotDistinct", + "error":{ + "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more batch entries have the same Id in the request.

" + }, + { + "shape":"BatchRequestTooLong", + "error":{ + "code":"AWS.SimpleQueueService.BatchRequestTooLong", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The length of all the messages put together is more than the limit.

" + }, + { + "shape":"InvalidBatchEntryId", + "error":{ + "code":"AWS.SimpleQueueService.InvalidBatchEntryId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The Id of a batch entry in a batch request does not abide\n by the specification.

" + }, + { + "shape":"UnsupportedOperation", + "error":{ + "code":"AWS.SimpleQueueService.UnsupportedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Error code 400. Unsupported operation.

" + } + ], + "documentation":"

Delivers up to ten messages to the specified queue.\n This is a batch version of SendMessage.\n The result of the send action on each message is reported individually in the response.\n The maximum allowed individual message size is 256 KB (262,144 bytes).

\n

The maximum total payload size (i.e., the sum of all a batch's individual message lengths)\n is also 256 KB (262,144 bytes).

\n

If the DelaySeconds parameter is not specified for an entry, \n the default for the queue is used.

\n The following list shows the characters (in Unicode) that are allowed in your message, according\n to the W3C XML specification. For more information, go to http://www.faqs.org/rfcs/rfc1321.html. \n If you send any characters that are not included in the list, your request will be rejected.\n

#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]

\n \n \n Because the batch request can result in a combination of successful and unsuccessful actions, \n you should check for batch errors even when the call returns an HTTP status code of 200. \n \n Some API actions take lists of parameters. These lists are specified using the param.n notation. Values\n of n are integers starting from 1. For example, a parameter list with two elements looks like this: \n \n

&Attribute.1=this

\n

&Attribute.2=that

\n\n \n \n The following example SendMessageBatch request sends two messages\n to the queue. You must URL encode the entire URL; however, we've URL encoded\n only the message body to make the example easier for you to read.\n The following example response includes the MD5 digest for the messages.\n \n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=SendMessageBatch\n&SendMessageBatchRequestEntry.1.Id=test_msg_001\n&SendMessageBatchRequestEntry.1.MessageBody=test%20message%20body%201\n&SendMessageBatchRequestEntry.2.Id=test_msg_002\n&SendMessageBatchRequestEntry.2.MessageBody=test%20message%20body%202\n&SendMessageBatchRequestEntry.2.DelaySeconds=60\n&SendMessageBatchRequestEntry.2.MessageAttribute.1.Name=test_attribute_name_1\n&SendMessageBatchRequestEntry.2.MessageAttribute.1.Value.StringValue=test_attribute_value_1\n&SendMessageBatchRequestEntry.2.MessageAttribute.1.Value.DataType=String\n&Version=2012-11-05\n&SignatureMethod=HmacSHA256\n&Expires=2014-05-05T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n\n \n test_msg_001\n 0a5231c7-8bff-4955-be2e-8dc7c50a25fa\n 0e024d309850c78cba5eabbeff7cae71\n \n \n test_msg_002\n 15ee1ed3-87e7-40c1-bdaa-2e49968ea7e9\n 7fb8146a82f95e0af155278f406862c2\n 295c5fa15a51aae6884d1d7c1d99ca50\n \n\n\n ca1ad5d0-8271-408b-8d0f-1351bf547e74\n\n\n\n \n \n " + }, + "SetQueueAttributes":{ + "name":"SetQueueAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetQueueAttributesRequest"}, + "errors":[ + { + "shape":"InvalidAttributeName", + "exception":true, + "documentation":"

The attribute referred to does not exist.

" + } + ], + "documentation":"

Sets the value of one or more queue attributes. When you change a queue's attributes, \n the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. \n Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

\n Going forward, new attributes might be added. \n If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.\n \n \n \n \n The following example Query request sets a policy that gives all users\n ReceiveMessage permission for the queue named testQueue. \n For more examples of policies, see \n Amazon SQS Policy Examples\n in the Amazon SQS Developer Guide. \n \n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=SetQueueAttributes\n&Version=2009-02-01\n&Attribute.Name=Policy\n&Attribute.Value=%7B%22Version%22%3A%222008-10-17%22%2C%22Id%22\n%3A%22%2F123456789012%2FtestQueue%2FSQSDefaultPolicy%22%2C%22Stat\nement%22%3A%5B%7B%22Sid%22%3A%22Queue1ReceiveMessage%22%2C%22Effe\nct%22%3A%22Allow%22%2C%22Principal%22%3A%7B%22AWS%22%3A%22*%22%7D\n%2C%22Action%22%3A%22SQS%3AReceiveMessage%22%2C%22Resource%22%3A%\n22arn%3Aaws%3Aaws%3Asqs%3Aus%2Deast%2D1%3A123456789012%3AtestQueue%22%7D%5D%7D\n&Timestamp=2009-05-06T16%3A57%3A31.000Z\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Signature=%2Bd7ZlPIdnb%2BhpEna2TgfwQjfGF8%3D\n\n \n \n \n \n The following example Query request sets the visibility timeout to 35 seconds for\n the queue named testQueue. Note: There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received by the queue, but have \n not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should \n delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages. \n \n \n \nhttp://sqs.us-east-1.amazonaws.com/123456789012/testQueue/\n?Action=SetQueueAttributes\n&Attribute.Name=VisibilityTimeout\n&Attribute.Value=35\n&Version=2009-02-01\n&SignatureMethod=HmacSHA256\n&Expires=2009-04-18T22%3A52%3A43PST\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Signature=Dqlp3Sd6ljTUA9Uf6SGtEExwUQEXAMPLE\n\n \n \n \n\n \n \n e5cca473-4fc0-4198-a451-8abb94d02c75\n \n \n\n\n \n \n " + } + }, + "shapes":{ + "AWSAccountIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AWSAccountId" + }, + "flattened":true + }, + "ActionNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ActionName" + }, + "flattened":true + }, + "AddPermissionRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Label", + "AWSAccountIds", + "Actions" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "Label":{ + "shape":"String", + "documentation":"

The unique identification of the permission you're setting (e.g.,\n AliceSendMessage). Constraints: Maximum 80 characters;\n alphanumeric characters, hyphens (-), and underscores (_) are allowed.

" + }, + "AWSAccountIds":{ + "shape":"AWSAccountIdList", + "documentation":"

The AWS account number of the principal\n who will be given permission. The principal must have an AWS account, but does\n not need to be signed up for Amazon SQS. For information about locating the AWS\n account identification, see Your\n AWS Identifiers in the Amazon SQS Developer Guide.

" + }, + "Actions":{ + "shape":"ActionNameList", + "documentation":"

The action the client wants to allow for the specified principal. \n The following are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl. \n For more information about these actions, see Understanding\n Permissions in the Amazon SQS Developer Guide.

\n

Specifying SendMessage,\n DeleteMessage, or ChangeMessageVisibility for the \n ActionName.n also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.

" + } + } + }, + "AttributeMap":{ + "type":"map", + "key":{ + "shape":"QueueAttributeName", + "documentation":"

The name of a queue attribute.

", + "locationName":"Name" + }, + "value":{ + "shape":"String", + "documentation":"

The value of a queue attribute.

", + "locationName":"Value" + }, + "flattened":true, + "locationName":"Attribute" + }, + "AttributeNameList":{ + "type":"list", + "member":{ + "shape":"QueueAttributeName", + "locationName":"AttributeName" + }, + "flattened":true + }, + "BatchEntryIdsNotDistinct":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more batch entries have the same Id in the request.

" + }, + "BatchRequestTooLong":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.BatchRequestTooLong", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The length of all the messages put together is more than the limit.

" + }, + "BatchResultErrorEntry":{ + "type":"structure", + "required":[ + "Id", + "SenderFault", + "Code" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

The id of an entry in a batch request.

" + }, + "SenderFault":{ + "shape":"Boolean", + "documentation":"

Whether the error happened due to the sender's fault.

" + }, + "Code":{ + "shape":"String", + "documentation":"

An error code representing why the action failed on this entry.

" + }, + "Message":{ + "shape":"String", + "documentation":"

A message explaining why the action failed on this entry.

" + } + }, + "documentation":"

This is used in the responses of batch API to give a detailed description\n of the result of an action on each entry in the request.

" + }, + "BatchResultErrorEntryList":{ + "type":"list", + "member":{ + "shape":"BatchResultErrorEntry", + "locationName":"BatchResultErrorEntry" + }, + "flattened":true + }, + "Binary":{"type":"blob"}, + "BinaryList":{ + "type":"list", + "member":{ + "shape":"Binary", + "locationName":"BinaryListValue" + } + }, + "Boolean":{"type":"boolean"}, + "ChangeMessageVisibilityBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "Entries":{ + "shape":"ChangeMessageVisibilityBatchRequestEntryList", + "documentation":"

A list of receipt handles of the messages for which the visibility timeout\n must be changed.

" + } + } + }, + "ChangeMessageVisibilityBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "ReceiptHandle" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

An identifier for this particular receipt handle. This is used to communicate\n the result. Note that the Ids of a batch request need to be\n unique within the request.

" + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

A receipt handle.

" + }, + "VisibilityTimeout":{ + "shape":"Integer", + "documentation":"

The new value (in seconds) for the message's visibility timeout.

" + } + }, + "documentation":"

Encloses a receipt handle and an entry id for each message in\n ChangeMessageVisibilityBatch.

\n \n \n

All of the following parameters are list parameters that must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, \n where n is an integer value starting with 1. For example, a parameter list for this action might look like this:

\n \n

&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2

\n

&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=Your_Receipt_Handle

\n

&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

" + }, + "ChangeMessageVisibilityBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"ChangeMessageVisibilityBatchRequestEntry", + "locationName":"ChangeMessageVisibilityBatchRequestEntry" + }, + "flattened":true + }, + "ChangeMessageVisibilityBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{ + "shape":"ChangeMessageVisibilityBatchResultEntryList", + "documentation":"

A list of ChangeMessageVisibilityBatchResultEntry items.

" + }, + "Failed":{ + "shape":"BatchResultErrorEntryList", + "documentation":"

A list of BatchResultErrorEntry items.

" + } + }, + "documentation":"

\n For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or \n a BatchResultErrorEntry tag if the message fails.\n

" + }, + "ChangeMessageVisibilityBatchResultEntry":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

Represents a message whose visibility timeout has been changed\n successfully.

" + } + }, + "documentation":"

Encloses the id of an entry in ChangeMessageVisibilityBatch.

" + }, + "ChangeMessageVisibilityBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"ChangeMessageVisibilityBatchResultEntry", + "locationName":"ChangeMessageVisibilityBatchResultEntry" + }, + "flattened":true + }, + "ChangeMessageVisibilityRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "ReceiptHandle", + "VisibilityTimeout" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

The receipt handle associated with the message whose visibility timeout\n should be changed. This parameter is returned by the ReceiveMessage action.

" + }, + "VisibilityTimeout":{ + "shape":"Integer", + "documentation":"

The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.

" + } + } + }, + "CreateQueueRequest":{ + "type":"structure", + "required":["QueueName"], + "members":{ + "QueueName":{ + "shape":"String", + "documentation":"

The name for the queue to be created.

" + }, + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request parameters the CreateQueue\n action uses:

\n

\n

\n

", + "locationName":"Attribute" + } + } + }, + "CreateQueueResult":{ + "type":"structure", + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL for the created Amazon SQS queue.

" + } + }, + "documentation":"

Returns the QueueUrl element of the created queue.

" + }, + "DeleteMessageBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "Entries":{ + "shape":"DeleteMessageBatchRequestEntryList", + "documentation":"

A list of receipt handles for the messages to be deleted.

" + } + } + }, + "DeleteMessageBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "ReceiptHandle" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

An identifier for this particular receipt handle. This is used to\n communicate the result. Note that the Ids of a batch request\n need to be unique within the request.

" + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

A receipt handle.

" + } + }, + "documentation":"

Encloses a receipt handle and an identifier for it.

" + }, + "DeleteMessageBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"DeleteMessageBatchRequestEntry", + "locationName":"DeleteMessageBatchRequestEntry" + }, + "flattened":true + }, + "DeleteMessageBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{ + "shape":"DeleteMessageBatchResultEntryList", + "documentation":"

A list of DeleteMessageBatchResultEntry items.

" + }, + "Failed":{ + "shape":"BatchResultErrorEntryList", + "documentation":"

A list of BatchResultErrorEntry items.

" + } + }, + "documentation":"

\n For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry tag if the message is deleted or \n a BatchResultErrorEntry tag if the message cannot be deleted.\n

" + }, + "DeleteMessageBatchResultEntry":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

Represents a successfully deleted message.

" + } + }, + "documentation":"

Encloses the id an entry in DeleteMessageBatch.

" + }, + "DeleteMessageBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"DeleteMessageBatchResultEntry", + "locationName":"DeleteMessageBatchResultEntry" + }, + "flattened":true + }, + "DeleteMessageRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "ReceiptHandle" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

The receipt handle associated with the message to delete.

" + } + } + }, + "DeleteQueueRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + } + } + }, + "EmptyBatchRequest":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.EmptyBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Batch request does not contain an entry.

" + }, + "GetQueueAttributesRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

A list of attributes to retrieve information for.

" + } + } + }, + "GetQueueAttributesResult":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

A map of attributes to the respective values.

", + "locationName":"Attribute" + } + }, + "documentation":"A list of returned queue attributes." + }, + "GetQueueUrlRequest":{ + "type":"structure", + "required":["QueueName"], + "members":{ + "QueueName":{ + "shape":"String", + "documentation":"

The name of the queue whose URL must be fetched. \n Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

" + }, + "QueueOwnerAWSAccountId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account that created the queue.

" + } + } + }, + "GetQueueUrlResult":{ + "type":"structure", + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL for the queue.

" + } + }, + "documentation":"

For more information, see \n Responses\n in the Amazon SQS Developer Guide.

" + }, + "Integer":{"type":"integer"}, + "InvalidAttributeName":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

The attribute referred to does not exist.

" + }, + "InvalidBatchEntryId":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.InvalidBatchEntryId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The Id of a batch entry in a batch request does not abide\n by the specification.

" + }, + "InvalidIdFormat":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

The receipt handle is not valid for the current version.

" + }, + "InvalidMessageContents":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

The message contains characters outside the allowed set.

" + }, + "ListDeadLetterSourceQueuesRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"The queue URL of a dead letter queue." + } + } + }, + "ListDeadLetterSourceQueuesResult":{ + "type":"structure", + "required":["queueUrls"], + "members":{ + "queueUrls":{ + "shape":"QueueUrlList", + "documentation":"A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue." + } + }, + "documentation":"A list of your dead letter source queues." + }, + "ListQueuesRequest":{ + "type":"structure", + "members":{ + "QueueNamePrefix":{ + "shape":"String", + "documentation":"

A string to use for filtering the list results. Only those queues whose name\n begins with the specified string are returned.

" + } + } + }, + "ListQueuesResult":{ + "type":"structure", + "members":{ + "QueueUrls":{ + "shape":"QueueUrlList", + "documentation":"

A list of queue URLs, up to 1000 entries.

" + } + }, + "documentation":"A list of your queues." + }, + "Message":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"String", + "documentation":"

A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.

" + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

An identifier associated with the act of receiving the message. \n A new receipt handle is returned every time you receive a message. \n When deleting a message, you provide the last received receipt handle to delete the message.

" + }, + "MD5OfBody":{ + "shape":"String", + "documentation":"

An MD5 digest of the non-URL-encoded message body string.

" + }, + "Body":{ + "shape":"String", + "documentation":"

The message's contents (not URL-encoded).

" + }, + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

SenderId, SentTimestamp, ApproximateReceiveCount, and/or \n ApproximateFirstReceiveTimestamp. SentTimestamp\n and ApproximateFirstReceiveTimestamp are each returned as an integer representing the \n epoch time in milliseconds.

", + "locationName":"Attribute" + }, + "MD5OfMessageAttributes":{ + "shape":"String", + "documentation":"

An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.

" + }, + "MessageAttributes":{ + "shape":"MessageAttributeMap", + "documentation":"

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.

", + "locationName":"MessageAttribute" + } + }, + "documentation":"

An Amazon SQS message.

" + }, + "MessageAttributeMap":{ + "type":"map", + "key":{ + "shape":"String", + "locationName":"Name" + }, + "value":{ + "shape":"MessageAttributeValue", + "locationName":"Value" + }, + "flattened":true + }, + "MessageAttributeName":{"type":"string"}, + "MessageAttributeNameList":{ + "type":"list", + "member":{ + "shape":"MessageAttributeName", + "locationName":"MessageAttributeName" + }, + "flattened":true + }, + "MessageAttributeValue":{ + "type":"structure", + "required":["DataType"], + "members":{ + "StringValue":{ + "shape":"String", + "documentation":"

Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

" + }, + "BinaryValue":{ + "shape":"Binary", + "documentation":"

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

" + }, + "StringListValues":{ + "shape":"StringList", + "documentation":"

Not implemented. Reserved for future use.

", + "flattened":true, + "locationName":"StringListValue" + }, + "BinaryListValues":{ + "shape":"BinaryList", + "documentation":"

Not implemented. Reserved for future use.

", + "flattened":true, + "locationName":"BinaryListValue" + }, + "DataType":{ + "shape":"String", + "documentation":"

Amazon SQS supports the following logical data types: String, Number, and Binary. In addition, you can append your own custom labels. For more information, see Message Attribute Data Types.

" + } + }, + "documentation":"

The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

\n

Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).

" + }, + "MessageList":{ + "type":"list", + "member":{ + "shape":"Message", + "locationName":"Message" + }, + "flattened":true + }, + "MessageNotInflight":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.MessageNotInflight", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The message referred to is not in flight.

" + }, + "OverLimit":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OverLimit", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The action that you requested would violate a limit. For example,\n ReceiveMessage returns this error if the maximum number of messages\n inflight has already been reached. AddPermission returns this error if\n the maximum number of permissions for the queue has already been reached.\n

" + }, + "QueueAttributeName":{ + "type":"string", + "enum":[ + "Policy", + "VisibilityTimeout", + "MaximumMessageSize", + "MessageRetentionPeriod", + "ApproximateNumberOfMessages", + "ApproximateNumberOfMessagesNotVisible", + "CreatedTimestamp", + "LastModifiedTimestamp", + "QueueArn", + "ApproximateNumberOfMessagesDelayed", + "DelaySeconds", + "ReceiveMessageWaitTimeSeconds", + "RedrivePolicy" + ] + }, + "QueueDeletedRecently":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.QueueDeletedRecently", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You must wait 60 seconds after deleting a queue before you can create another\n with the same name.

" + }, + "QueueDoesNotExist":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.NonExistentQueue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The queue referred to does not exist.

" + }, + "QueueNameExists":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QueueAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A queue already exists with this name. Amazon SQS returns this error only if the request includes\n attributes whose values differ from those of the existing queue.

" + }, + "QueueUrlList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"QueueUrl" + }, + "flattened":true + }, + "ReceiptHandleIsInvalid":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

The receipt handle provided is not valid.

" + }, + "ReceiveMessageRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

A list of attributes that need to be returned along with each message. \n

\n

\n The following lists the names and descriptions of the attributes that can be returned:\n

\n " + }, + "MessageAttributeNames":{ + "shape":"MessageAttributeNameList", + "documentation":"

The message attribute Name can contain the following characters: A-Z, a-z, 0-9, underscore(_), hyphen(-), and period (.). \n The message attribute name must not start or end with a period, and it should not have successive periods. The message attribute name is case sensitive and must be unique among all attribute \n names for the message. The message attribute name can be up to 256 characters long. Attribute names cannot start with \"AWS.\" or \"Amazon.\" because these prefixes are reserved for use by Amazon Web Services.

" + }, + "MaxNumberOfMessages":{ + "shape":"Integer", + "documentation":"

The maximum number of messages to return. Amazon SQS never returns more\n messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

\n\n

All of the messages are not necessarily returned.

" + }, + "VisibilityTimeout":{ + "shape":"Integer", + "documentation":"

The duration (in seconds) that the received messages are hidden from\n subsequent retrieve requests after being retrieved by a\n ReceiveMessage request.

" + }, + "WaitTimeSeconds":{ + "shape":"Integer", + "documentation":"

The duration (in seconds) for which the call will wait for a message to arrive\n in the queue before returning. If a message is available, the call will\n return sooner than WaitTimeSeconds.

" + } + } + }, + "ReceiveMessageResult":{ + "type":"structure", + "members":{ + "Messages":{ + "shape":"MessageList", + "documentation":"

A list of messages.

" + } + }, + "documentation":"A list of received messages." + }, + "RemovePermissionRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Label" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "Label":{ + "shape":"String", + "documentation":"

The identification of the permission to remove. This is the label added with\n the AddPermission action.

" + } + } + }, + "SendMessageBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "Entries":{ + "shape":"SendMessageBatchRequestEntryList", + "documentation":"

A list of SendMessageBatchRequestEntry items.

" + } + } + }, + "SendMessageBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "MessageBody" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

An identifier for the message in this batch. This is used to communicate\n the result. Note that the Ids of a batch request need to\n be unique within the request.

" + }, + "MessageBody":{ + "shape":"String", + "documentation":"

Body of the message.

" + }, + "DelaySeconds":{ + "shape":"Integer", + "documentation":"

The number of seconds for which the message has to be delayed.

" + }, + "MessageAttributes":{ + "shape":"MessageAttributeMap", + "documentation":"

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.

", + "locationName":"MessageAttribute" + } + }, + "documentation":"

Contains the details of a single Amazon SQS message along with a Id.

" + }, + "SendMessageBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"SendMessageBatchRequestEntry", + "locationName":"SendMessageBatchRequestEntry" + }, + "flattened":true + }, + "SendMessageBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{ + "shape":"SendMessageBatchResultEntryList", + "documentation":"

A list of SendMessageBatchResultEntry items.

" + }, + "Failed":{ + "shape":"BatchResultErrorEntryList", + "documentation":"

A list of BatchResultErrorEntry items with the error detail about each\n message that could not be enqueued.

" + } + }, + "documentation":"

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

" + }, + "SendMessageBatchResultEntry":{ + "type":"structure", + "required":[ + "Id", + "MessageId", + "MD5OfMessageBody" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

An identifier for the message in this batch.

" + }, + "MessageId":{ + "shape":"String", + "documentation":"

An identifier for the message.

" + }, + "MD5OfMessageBody":{ + "shape":"String", + "documentation":"

An MD5 digest of the non-URL-encoded message body string. This can be used to\n verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the\n message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.

" + }, + "MD5OfMessageAttributes":{ + "shape":"String", + "documentation":"

An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.

" + } + }, + "documentation":"

Encloses a message ID for successfully enqueued message of a\n SendMessageBatch.

" + }, + "SendMessageBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"SendMessageBatchResultEntry", + "locationName":"SendMessageBatchResultEntry" + }, + "flattened":true + }, + "SendMessageRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "MessageBody" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "MessageBody":{ + "shape":"String", + "documentation":"

The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.

" + }, + "DelaySeconds":{ + "shape":"Integer", + "documentation":"

\n The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value \n become available for processing after the delay time is finished.\n If you don't specify a value, the default value for the queue applies.\n

" + }, + "MessageAttributes":{ + "shape":"MessageAttributeMap", + "documentation":"

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.

", + "locationName":"MessageAttribute" + } + } + }, + "SendMessageResult":{ + "type":"structure", + "members":{ + "MD5OfMessageBody":{ + "shape":"String", + "documentation":"

An MD5 digest of the non-URL-encoded message body string. This can be used to\n verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the\n message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.

" + }, + "MD5OfMessageAttributes":{ + "shape":"String", + "documentation":"

An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.

" + }, + "MessageId":{ + "shape":"String", + "documentation":"

\n An element containing the message ID of the message sent to the queue. \n \n For more information, see \n Queue and Message Identifiers\n in the Amazon SQS Developer Guide.\n

" + } + }, + "documentation":"

The MD5OfMessageBody and MessageId elements.

" + }, + "SetQueueAttributesRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Attributes" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

The URL of the Amazon SQS queue to take action on.

" + }, + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request parameters the SetQueueAttributes\n action uses:

\n

\n

\n

", + "locationName":"Attribute" + } + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"StringListValue" + } + }, + "TooManyEntriesInBatchRequest":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Batch request contains more number of entries than permissible.

" + }, + "UnsupportedOperation":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.UnsupportedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Error code 400. Unsupported operation.

" + } + } +} diff --git a/apis/sqs-2012-11-05.paginators.json b/apis/sqs-2012-11-05.paginators.json new file mode 100644 index 0000000000..e7ac48a9f9 --- /dev/null +++ b/apis/sqs-2012-11-05.paginators.json @@ -0,0 +1,7 @@ +{ + "pagination": { + "ListQueues": { + "result_key": "QueueUrls" + } + } +} diff --git a/apis/storagegateway-2013-06-30.api.json b/apis/storagegateway-2013-06-30.api.json new file mode 100644 index 0000000000..1a388e4946 --- /dev/null +++ b/apis/storagegateway-2013-06-30.api.json @@ -0,0 +1,1257 @@ +{ + "metadata": { + "apiVersion": "2013-06-30", + "endpointPrefix": "storagegateway", + "jsonVersion": "1.1", + "serviceFullName": "AWS Storage Gateway", + "signatureVersion": "v4", + "targetPrefix": "StorageGateway_20130630", + "protocol": "json" + }, + "operations": { + "ActivateGateway": { + "input": { + "type": "structure", + "required": [ + "ActivationKey", + "GatewayName", + "GatewayTimezone", + "GatewayRegion" + ], + "members": { + "ActivationKey": {}, + "GatewayName": {}, + "GatewayTimezone": {}, + "GatewayRegion": {}, + "GatewayType": {}, + "TapeDriveType": {}, + "MediumChangerType": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "AddCache": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DiskIds" + ], + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "AddUploadBuffer": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DiskIds" + ], + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "AddWorkingStorage": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DiskIds" + ], + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "CancelArchival": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeARN" + ], + "members": { + "GatewayARN": {}, + "TapeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "CancelRetrieval": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeARN" + ], + "members": { + "GatewayARN": {}, + "TapeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "CreateCachediSCSIVolume": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "VolumeSizeInBytes", + "TargetName", + "NetworkInterfaceId", + "ClientToken" + ], + "members": { + "GatewayARN": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "SnapshotId": {}, + "TargetName": {}, + "NetworkInterfaceId": {}, + "ClientToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "TargetARN": {} + } + } + }, + "CreateSnapshot": { + "input": { + "type": "structure", + "required": [ + "VolumeARN", + "SnapshotDescription" + ], + "members": { + "VolumeARN": {}, + "SnapshotDescription": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "SnapshotId": {} + } + } + }, + "CreateSnapshotFromVolumeRecoveryPoint": { + "input": { + "type": "structure", + "required": [ + "VolumeARN", + "SnapshotDescription" + ], + "members": { + "VolumeARN": {}, + "SnapshotDescription": {} + } + }, + "output": { + "type": "structure", + "members": { + "SnapshotId": {}, + "VolumeARN": {}, + "VolumeRecoveryPointTime": {} + } + } + }, + "CreateStorediSCSIVolume": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "DiskId", + "PreserveExistingData", + "TargetName", + "NetworkInterfaceId" + ], + "members": { + "GatewayARN": {}, + "DiskId": {}, + "SnapshotId": {}, + "PreserveExistingData": { + "type": "boolean" + }, + "TargetName": {}, + "NetworkInterfaceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "TargetARN": {} + } + } + }, + "CreateTapes": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeSizeInBytes", + "ClientToken", + "NumTapesToCreate", + "TapeBarcodePrefix" + ], + "members": { + "GatewayARN": {}, + "TapeSizeInBytes": { + "type": "long" + }, + "ClientToken": {}, + "NumTapesToCreate": { + "type": "integer" + }, + "TapeBarcodePrefix": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARNs": { + "shape": "S1b" + } + } + } + }, + "DeleteBandwidthRateLimit": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "BandwidthType" + ], + "members": { + "GatewayARN": {}, + "BandwidthType": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "DeleteChapCredentials": { + "input": { + "type": "structure", + "required": [ + "TargetARN", + "InitiatorName" + ], + "members": { + "TargetARN": {}, + "InitiatorName": {} + } + }, + "output": { + "type": "structure", + "members": { + "TargetARN": {}, + "InitiatorName": {} + } + } + }, + "DeleteGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "DeleteSnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "VolumeARN" + ], + "members": { + "VolumeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {} + } + } + }, + "DeleteTape": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "TapeARN" + ], + "members": { + "GatewayARN": {}, + "TapeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "DeleteTapeArchive": { + "input": { + "type": "structure", + "required": [ + "TapeARN" + ], + "members": { + "TapeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "DeleteVolume": { + "input": { + "type": "structure", + "required": [ + "VolumeARN" + ], + "members": { + "VolumeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {} + } + } + }, + "DescribeBandwidthRateLimit": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "AverageUploadRateLimitInBitsPerSec": { + "type": "long" + }, + "AverageDownloadRateLimitInBitsPerSec": { + "type": "long" + } + } + } + }, + "DescribeCache": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sc" + }, + "CacheAllocatedInBytes": { + "type": "long" + }, + "CacheUsedPercentage": { + "type": "double" + }, + "CacheDirtyPercentage": { + "type": "double" + }, + "CacheHitPercentage": { + "type": "double" + }, + "CacheMissPercentage": { + "type": "double" + } + } + } + }, + "DescribeCachediSCSIVolumes": { + "input": { + "type": "structure", + "required": [ + "VolumeARNs" + ], + "members": { + "VolumeARNs": { + "shape": "S20" + } + } + }, + "output": { + "type": "structure", + "members": { + "CachediSCSIVolumes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeId": {}, + "VolumeType": {}, + "VolumeStatus": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "VolumeProgress": { + "type": "double" + }, + "SourceSnapshotId": {}, + "VolumeiSCSIAttributes": { + "shape": "S28" + } + } + } + } + } + } + }, + "DescribeChapCredentials": { + "input": { + "type": "structure", + "required": [ + "TargetARN" + ], + "members": { + "TargetARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "ChapCredentials": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TargetARN": {}, + "SecretToAuthenticateInitiator": {}, + "InitiatorName": {}, + "SecretToAuthenticateTarget": {} + } + } + } + } + } + }, + "DescribeGatewayInformation": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "GatewayId": {}, + "GatewayTimezone": {}, + "GatewayState": {}, + "GatewayNetworkInterfaces": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Ipv4Address": {}, + "MacAddress": {}, + "Ipv6Address": {} + } + } + }, + "GatewayType": {}, + "NextUpdateAvailabilityDate": {} + } + } + }, + "DescribeMaintenanceStartTime": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "HourOfDay": { + "type": "integer" + }, + "MinuteOfHour": { + "type": "integer" + }, + "DayOfWeek": { + "type": "integer" + }, + "Timezone": {} + } + } + }, + "DescribeSnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "VolumeARN" + ], + "members": { + "VolumeARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {}, + "StartAt": { + "type": "integer" + }, + "RecurrenceInHours": { + "type": "integer" + }, + "Description": {}, + "Timezone": {} + } + } + }, + "DescribeStorediSCSIVolumes": { + "input": { + "type": "structure", + "required": [ + "VolumeARNs" + ], + "members": { + "VolumeARNs": { + "shape": "S20" + } + } + }, + "output": { + "type": "structure", + "members": { + "StorediSCSIVolumes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeId": {}, + "VolumeType": {}, + "VolumeStatus": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "VolumeProgress": { + "type": "double" + }, + "VolumeDiskId": {}, + "SourceSnapshotId": {}, + "PreservedExistingData": { + "type": "boolean" + }, + "VolumeiSCSIAttributes": { + "shape": "S28" + } + } + } + } + } + } + }, + "DescribeTapeArchives": { + "input": { + "type": "structure", + "members": { + "TapeARNs": { + "shape": "S1b" + }, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "TapeArchives": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TapeARN": {}, + "TapeBarcode": {}, + "TapeSizeInBytes": { + "type": "long" + }, + "CompletionTime": { + "type": "timestamp" + }, + "RetrievedTo": {}, + "TapeStatus": {} + } + } + }, + "Marker": {} + } + } + }, + "DescribeTapeRecoveryPoints": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "TapeRecoveryPointInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TapeARN": {}, + "TapeRecoveryPointTime": { + "type": "timestamp" + }, + "TapeSizeInBytes": { + "type": "long" + }, + "TapeStatus": {} + } + } + }, + "Marker": {} + } + } + }, + "DescribeTapes": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "TapeARNs": { + "shape": "S1b" + }, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Tapes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TapeARN": {}, + "TapeBarcode": {}, + "TapeSizeInBytes": { + "type": "long" + }, + "TapeStatus": {}, + "VTLDevice": {}, + "Progress": { + "type": "double" + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeUploadBuffer": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sc" + }, + "UploadBufferUsedInBytes": { + "type": "long" + }, + "UploadBufferAllocatedInBytes": { + "type": "long" + } + } + } + }, + "DescribeVTLDevices": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "VTLDeviceARNs": { + "type": "list", + "member": {} + }, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "VTLDevices": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VTLDeviceARN": {}, + "VTLDeviceType": {}, + "VTLDeviceVendor": {}, + "VTLDeviceProductIdentifier": {}, + "DeviceiSCSIAttributes": { + "type": "structure", + "members": { + "TargetARN": {}, + "NetworkInterfaceId": {}, + "NetworkInterfacePort": { + "type": "integer" + }, + "ChapEnabled": { + "type": "boolean" + } + } + } + } + } + }, + "Marker": {} + } + } + }, + "DescribeWorkingStorage": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "DiskIds": { + "shape": "Sc" + }, + "WorkingStorageUsedInBytes": { + "type": "long" + }, + "WorkingStorageAllocatedInBytes": { + "type": "long" + } + } + } + }, + "DisableGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "ListGateways": { + "input": { + "type": "structure", + "members": { + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Gateways": { + "type": "list", + "member": { + "type": "structure", + "members": { + "GatewayARN": {}, + "GatewayType": {}, + "GatewayOperationalState": {} + } + } + }, + "Marker": {} + } + } + }, + "ListLocalDisks": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "Disks": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DiskId": {}, + "DiskPath": {}, + "DiskNode": {}, + "DiskSizeInBytes": { + "type": "long" + }, + "DiskAllocationType": {}, + "DiskAllocationResource": {} + } + } + } + } + } + }, + "ListVolumeRecoveryPoints": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "VolumeRecoveryPointInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeSizeInBytes": { + "type": "long" + }, + "VolumeUsageInBytes": { + "type": "long" + }, + "VolumeRecoveryPointTime": {} + } + } + } + } + } + }, + "ListVolumes": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "Marker": {}, + "Limit": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {}, + "Marker": {}, + "VolumeInfos": { + "type": "list", + "member": { + "type": "structure", + "members": { + "VolumeARN": {}, + "VolumeType": {} + } + } + } + } + } + }, + "RetrieveTapeArchive": { + "input": { + "type": "structure", + "required": [ + "TapeARN", + "GatewayARN" + ], + "members": { + "TapeARN": {}, + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "RetrieveTapeRecoveryPoint": { + "input": { + "type": "structure", + "required": [ + "TapeARN", + "GatewayARN" + ], + "members": { + "TapeARN": {}, + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "TapeARN": {} + } + } + }, + "ShutdownGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "StartGateway": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateBandwidthRateLimit": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "AverageUploadRateLimitInBitsPerSec": { + "type": "long" + }, + "AverageDownloadRateLimitInBitsPerSec": { + "type": "long" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateChapCredentials": { + "input": { + "type": "structure", + "required": [ + "TargetARN", + "SecretToAuthenticateInitiator", + "InitiatorName" + ], + "members": { + "TargetARN": {}, + "SecretToAuthenticateInitiator": {}, + "InitiatorName": {}, + "SecretToAuthenticateTarget": {} + } + }, + "output": { + "type": "structure", + "members": { + "TargetARN": {}, + "InitiatorName": {} + } + } + }, + "UpdateGatewayInformation": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {}, + "GatewayName": {}, + "GatewayTimezone": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateGatewaySoftwareNow": { + "input": { + "type": "structure", + "required": [ + "GatewayARN" + ], + "members": { + "GatewayARN": {} + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateMaintenanceStartTime": { + "input": { + "type": "structure", + "required": [ + "GatewayARN", + "HourOfDay", + "MinuteOfHour", + "DayOfWeek" + ], + "members": { + "GatewayARN": {}, + "HourOfDay": { + "type": "integer" + }, + "MinuteOfHour": { + "type": "integer" + }, + "DayOfWeek": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "GatewayARN": {} + } + } + }, + "UpdateSnapshotSchedule": { + "input": { + "type": "structure", + "required": [ + "VolumeARN", + "StartAt", + "RecurrenceInHours" + ], + "members": { + "VolumeARN": {}, + "StartAt": { + "type": "integer" + }, + "RecurrenceInHours": { + "type": "integer" + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "VolumeARN": {} + } + } + } + }, + "shapes": { + "Sc": { + "type": "list", + "member": {} + }, + "S1b": { + "type": "list", + "member": {} + }, + "S20": { + "type": "list", + "member": {} + }, + "S28": { + "type": "structure", + "members": { + "TargetARN": {}, + "NetworkInterfaceId": {}, + "NetworkInterfacePort": { + "type": "integer" + }, + "LunNumber": { + "type": "integer" + }, + "ChapEnabled": { + "type": "boolean" + } + } + } + } +} \ No newline at end of file diff --git a/apis/storagegateway-2013-06-30.full.json b/apis/storagegateway-2013-06-30.full.json new file mode 100644 index 0000000000..83d002bdee --- /dev/null +++ b/apis/storagegateway-2013-06-30.full.json @@ -0,0 +1,3153 @@ +{ + "metadata":{ + "apiVersion":"2013-06-30", + "endpointPrefix":"storagegateway", + "jsonVersion":"1.1", + "serviceFullName":"AWS Storage Gateway", + "signatureVersion":"v4", + "targetPrefix":"StorageGateway_20130630", + "protocol":"json" + }, + "documentation":"AWS Storage Gateway Service\n\n

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to\n provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage\n infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and\n rapid disaster recovery.

\n\n

Use the following links to get started using the AWS Storage Gateway Service API Reference:

\n ", + "operations":{ + "ActivateGateway":{ + "name":"ActivateGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ActivateGatewayInput", + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "output":{ + "shape":"ActivateGatewayOutput", + "documentation":"

AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of\n information such as your account, gateway name, and region. This ARN is\n used to reference the gateway in other API operations as well as\n resource-based authorization.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation activates the gateway you previously deployed on your host. For more\n information, see Downloading \n and Deploying AWS Storage Gateway VM. In the activation process you\n specify information such as the region you want to use for storing snapshots, the time zone\n for scheduled snapshots and the gateway schedule window, an activation key, and a name for\n your gateway. The activation process also associates your gateway with your account (see UpdateGatewayInformation).

\n You must power on the gateway VM before you can activate your gateway.\n \n \n Example Request\n The following example shows a request that activates a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ActivateGateway\n{\n \"ActivationKey\": \"29AV1-3OFV9-VVIUB-NKT0I-LRO6V\",\n \"GatewayName\": \"mygateway\",\n \"GatewayTimezone\": \"GMT-12:00\",\n \"GatewayRegion\": \"us-east-1\",\n \"GatewayType\": \"STORED\"\n}\n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n \n \n " + }, + "AddCache":{ + "name":"AddCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddCacheInput"}, + "output":{"shape":"AddCacheOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation configures one or more gateway local disks as cache for a cached-volume\n gateway. This operation is supported only for the gateway-cached volume architecture (see\n Storage Gateway Concepts).

\n

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and \n one or more disk IDs that you want to configure as cache.

\n \n \n Example Request\n The following example shows a request that activates a gateway.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120425T120000Z\nx-amz-target: StorageGateway_20120630.AddCache\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n \"DiskIds\": [ \n \"pci-0000:03:00.0-scsi-0:0:0:0\", \n \"pci-0000:03:00.0-scsi-0:0:1:0\"\n ] \n}\n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 85\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n \n \n " + }, + "AddUploadBuffer":{ + "name":"AddUploadBuffer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddUploadBufferInput"}, + "output":{"shape":"AddUploadBufferOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation configures one or more gateway local disks as upload buffer for a specified gateway. \n This operation is supported for both the gateway-stored and gateway-cached volume architectures.\n

\n

\n In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer,\n and one or more disk IDs that you want to configure as upload buffer.

" + }, + "AddWorkingStorage":{ + "name":"AddWorkingStorage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddWorkingStorageInput", + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "output":{ + "shape":"AddWorkingStorageOutput", + "documentation":"

A JSON object containing the of the gateway for which working storage was configured.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation configures one or more gateway local disks as working storage for a gateway. \n This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead.

\n

Working storage is also referred to as upload buffer. You can also use the \n AddUploadBuffer operation to add upload buffer to a stored-volume gateway.

\n

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage,\n and one or more disk IDs that you want to configure as working storage.

\n \n \n Example Request\n The following example shows a request that specifies that two local disks of a gateway are to\n be configured as working storage.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.AddWorkingStorage\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n \"DiskIds\": [\"pci-0000:03:00.0-scsi-0:0:0:0\", \"pci-0000:04:00.0-scsi-1:0:0:0\"]\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n \n \n " + }, + "CancelArchival":{ + "name":"CancelArchival", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CancelArchivalInput", + "documentation":"

CancelArchivalInput

" + }, + "output":{ + "shape":"CancelArchivalOutput", + "documentation":"

CancelArchivalOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.\n

" + }, + "CancelRetrieval":{ + "name":"CancelRetrieval", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CancelRetrievalInput", + "documentation":"

CancelRetrievalInput

" + }, + "output":{ + "shape":"CancelRetrievalOutput", + "documentation":"

CancelRetrievalOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.\n The virtual tape is returned to the VTS.

" + }, + "CreateCachediSCSIVolume":{ + "name":"CreateCachediSCSIVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCachediSCSIVolumeInput"}, + "output":{"shape":"CreateCachediSCSIVolumeOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation creates a cached volume on a specified cached gateway. This operation is\n supported only for the gateway-cached volume architecture.

\n Cache storage must be allocated to the gateway before you can create a cached volume.\n Use the AddCache operation to add cache storage to a gateway. \n

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI\n target name, an IP address on which to expose the target, and a unique client token. In\n response, AWS Storage Gateway creates the volume and returns information about it such\n as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that\n initiators can use to connect to the volume target.

\n \n \n Example Request\n The following example shows a request that specifies that a local disk of a gateway be\n configured as a cached volume.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.CreateCachediSCSIVolume\n{\n \"ClientToken\": \"cachedvol112233\",\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"NetworkInterfaceId\": \"10.1.1.1\",\n \"TargetName\": \"myvolume\",\n \"VolumeSizeInBytes\": 536870912000\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 263\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n \n \n " + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateSnapshotInput", + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "output":{ + "shape":"CreateSnapshotOutput", + "documentation":"

A JSON object containing the following fields:

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation initiates a snapshot of a volume.

\n

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple\n Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS)\n volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or\n ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working\n With Snapshots in the AWS Storage Gateway Console.

\n

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must\n also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the\n snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns\n you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to\n create a volume from a snapshot.

\n To list or delete a snapshot, you must use the Amazon EC2 API. For more information, .\n \n \n Example Request\n The following example sends a CreateSnapshot request to take snapshot of the\n specified an example volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.CreateSnapshot\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotDescription\": \"snapshot description\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 128\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotId\": \"snap-78e22663\"\n}\n \n \n " + }, + "CreateSnapshotFromVolumeRecoveryPoint":{ + "name":"CreateSnapshotFromVolumeRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotFromVolumeRecoveryPointInput"}, + "output":{"shape":"CreateSnapshotFromVolumeRecoveryPointOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).

\n

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, \n use ListVolumeRecoveryPoints.

\n

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

\n \n

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

\n \n \n \n Example Request\n The following example sends a\n CreateSnapshotFromVolumeRecoveryPoint request to take snapshot of the\n specified an example volume.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.CreateSnapshotFromVolumeRecoveryPoint\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotDescription\": \"snapshot description\"\n}\n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"SnapshotId\": \"snap-78e22663\",\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeRecoveryPointTime\": \"2012-06-30T10:10:10.000Z\" \n} \n\n \n \n " + }, + "CreateStorediSCSIVolume":{ + "name":"CreateStorediSCSIVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateStorediSCSIVolumeInput", + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "output":{ + "shape":"CreateStorediSCSIVolumeOutput", + "documentation":"

A JSON object containing the following fields:

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.\n

\n

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

\n

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

\n \n \n Example Request\n The following example shows a request that specifies that a local disk of a gateway be\n configured as a volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.CreateStorediSCSIVolume\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"PreserveExistingData\": true,\n \"TargetName\": \"myvolume\",\n \"NetworkInterfaceId\": \"10.1.1.1\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 215\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeSizeInBytes\": 1099511627776,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n}\n \n \n " + }, + "CreateTapes":{ + "name":"CreateTapes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateTapesInput", + "documentation":"

CreateTapesInput

" + }, + "output":{ + "shape":"CreateTapesOutput", + "documentation":"

CreateTapeOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.

\n Cache storage must be allocated to the gateway before you can create virtual tapes.\n Use the AddCache operation to add cache storage to a gateway. \n \n \n Create tapes in gateway-VTL\n In the following request you add three virtual tape cartridges, 100 GB each, to the \n gateway-VTL (ExampleGatewayVTL). The tapes appear in the gateway's VTL. \n In the request you set the tape's barcode prefix to \"TEST\".\n {\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL\",\n \"TapeSizeInBytes\":107374182400,\n \"ClientToken\":\"77777\",\n \"NumTapesToCreate\":3,\n \"TapeBarcodePrefix\":\"TEST\"\n}\n \n {\"TapeARNs\": \n [\"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D\", \"arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F\", \"arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E\"]\n}\n \n \n " + }, + "DeleteBandwidthRateLimit":{ + "name":"DeleteBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBandwidthRateLimitInput"}, + "output":{ + "shape":"DeleteBandwidthRateLimitOutput", + "documentation":"

A JSON object containing the of the gateway whose bandwidth rate information was deleted.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download\n bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains\n unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your\n request.

\n \n \n Example Request\n The following example shows a request that deletes both of the bandwidth rate limits of a\n gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"BandwidthType: \"All\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n " + }, + "DeleteChapCredentials":{ + "name":"DeleteChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteChapCredentialsInput", + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "output":{ + "shape":"DeleteChapCredentialsOutput", + "documentation":"

A JSON object containing the following fields:

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI\n target and initiator pair.

\n \n \n Example Request\n The following example shows a request that deletes the CHAP credentials for an iSCSI target\n myvolume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 161\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n \n \n " + }, + "DeleteGateway":{ + "name":"DeleteGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteGatewayInput", + "documentation":"

A JSON object containing the of the gateway to delete.

" + }, + "output":{ + "shape":"DeleteGatewayOutput", + "documentation":"

A JSON object containing the of the deleted gateway.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the\n gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual\n machine (VM) from your host computer.

\n

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not\n deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway,\n your next step is to remove it from your environment.

\n \n

You no longer pay software charges after the gateway is deleted; however, your existing\n Amazon EBS snapshots persist and you will continue to be billed for these\n snapshots. You can choose to remove all remaining Amazon EBS snapshots by\n canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon\n EC2 subscription, you can delete your snapshots using the Amazon EC2 console.\n For more information, see the \n AWS Storage Gateway Detail Page.

\n \n \n \n Example Request\n The following example shows a request that deactivates a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n " + }, + "DeleteSnapshotSchedule":{ + "name":"DeleteSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotScheduleInput"}, + "output":{"shape":"DeleteSnapshotScheduleOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

\n This operation deletes a snapshot of a volume.\n

\n

\n You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API\n enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). \n

\n \n

To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API\n Reference.

\n \n \n \n Example Request\n The following example...\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DeleteSnapshotSchedule\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n \n \n " + }, + "DeleteTape":{ + "name":"DeleteTape", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteTapeInput", + "documentation":"

DeleteTapeInput

" + }, + "output":{ + "shape":"DeleteTapeOutput", + "documentation":"

DeleteTapeOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Deletes the specified virtual tape.

\n \n \n Delete a tape from a gateway\n The following example deletes a tape from a gateway-VTL (ExampleGatewayVTL). The request \n identifies the tape by its ARN. The operation deletes the tapes from the specified gateway's \n virtual tape library (VTL). In the response AWS Storage Gateway returns the ARN of deleted tape.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20131025T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9EXAMPLE\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteTape\n{\"GatewayARN\": \"arn:aws:storagegateway:us-east-1:204469490176:gateway/ExampleGatewayVTL\",\n \"TapeARN\": \"arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0\"}\n\n\n\n{\"TapeARN\": \"arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0\"}\n\n \n " + }, + "DeleteTapeArchive":{ + "name":"DeleteTapeArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteTapeArchiveInput", + "documentation":"

DeleteTapeArchiveInput

" + }, + "output":{ + "shape":"DeleteTapeArchiveOutput", + "documentation":"

DeleteTapeArchiveOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Deletes the specified virtual tape from the virtual tape shelf (VTS).

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteVolumeInput", + "documentation":"

A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

" + }, + "output":{ + "shape":"DeleteVolumeOutput", + "documentation":"

A JSON object containing the of the storage volume that was deleted

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation delete the specified gateway volume that you previously created using the\n CreateStorediSCSIVolume API. For gateway-stored volumes, the local disk that was configured as the storage\n volume is not deleted. You can reuse the local disk to create another storage volume.

\n

Before you delete a gateway volume, make sure there are no iSCSI connections to the volume\n you are deleting. You should also make sure there is no snapshot in progress. You can\n use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume\n you are deleting and check the snapshot status. For more information, go\n to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

\n

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

\n \n \n Example Request\n The following example shows a request that deletes a volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteVolume\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 99\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n \n \n " + }, + "DescribeBandwidthRateLimit":{ + "name":"DescribeBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeBandwidthRateLimitInput", + "documentation":"

A JSON object containing the of the gateway.

" + }, + "output":{ + "shape":"DescribeBandwidthRateLimitOutput", + "documentation":"

A JSON object containing the following fields:

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which\n means no bandwidth rate limiting is in effect.

\n

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set\n for the gateway, then this operation returns only the gateway ARN in the response body. To specify which\n gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request that returns the bandwidth throttle properties of a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygate way\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 169\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"AverageUploadRateLimitInBitsPerSec\": 102400,\n \"AverageDownloadRateLimitInBitsPerSec\": 51200\n}\n \n \n " + }, + "DescribeCache":{ + "name":"DescribeCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheInput"}, + "output":{"shape":"DescribeCacheOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns information about the cache of a gateway. \n This operation is supported only for the gateway-cached volume architecture.\n

\n

\n The response includes disk IDs that are configured as cache, and it \n includes the amount of cache allocated and used.

\n \n \n Example Request\n The following example shows a request to obtain a description of a gateway's\n working storage.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeCache\n\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 271\n\n{\n \"CacheAllocationInBytes\": 2199023255552,\n \"CacheDirtyPercentage\": 0.07,\n \"CacheHitPercentage\": 99.68,\n \"CacheMissPercentage\": 0.32,\n \"CacheUsedPercentage\": 0.07,\n \"DiskIds\": [\n \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"pci-0000:04:00.0-scsi-0:1:0:0\"\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n \n \n " + }, + "DescribeCachediSCSIVolumes":{ + "name":"DescribeCachediSCSIVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCachediSCSIVolumesInput"}, + "output":{ + "shape":"DescribeCachediSCSIVolumesOutput", + "documentation":"

A JSON object containing the following fields:

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns a description of the gateway volumes specified in the request. \n This operation is supported only for the gateway-cached volume architecture.

\n

\n The list of gateway volumes in the request must be from one gateway. \n In the response Amazon Storage Gateway returns volume information sorted by volume \n Amazon Resource Name (ARN).

\n \n \n Example Request\n The following example shows a request that returns a description of a volume.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeCachediSCSIVolumes\n\n{\n \"VolumeARNs\": [\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"]\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 664\n\n{\n \"CachediSCSIVolumes\": [\n {\n \"VolumeiSCSIAttributes\": {\n \"ChapEnabled\": true,\n \"LunNumber\": 0,\n \"NetworkInterfaceId\": \"10.243.43.207\",\n \"NetworkInterfacePort\": 3260,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n },\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeDiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"VolumeId\": \"vol-1122AABB\",\n \"VolumeSizeInBytes\": 1099511627776,\n \"VolumeStatus\": \"AVAILABLE\",\n \"VolumeType\": \"CACHED iSCSI\"\n }\n ]\n} \n\n \n \n " + }, + "DescribeChapCredentials":{ + "name":"DescribeChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeChapCredentialsInput", + "documentation":"

A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

" + }, + "output":{ + "shape":"DescribeChapCredentialsOutput", + "documentation":"

A JSON object containing a .

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information\n for a specified iSCSI target, one for each target-initiator pair.

\n \n \n Example Request\n The following example shows a request that returns the CHAP credentials of an iSCSI\n target.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 235\n{\n \"ChapCredentials\": {\n \"TargetName\": \"iqn.1997-05.com.amazon:myvolume\",\n \"SecretToAuthenticateInitiator\": \"111111111111\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\",\n \"SecretToAuthenticateTarget\": \"222222222222\"\n }\n}\n \n \n " + }, + "DescribeGatewayInformation":{ + "name":"DescribeGatewayInformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeGatewayInformationInput", + "documentation":"

A JSON object containing the of the gateway.

" + }, + "output":{ + "shape":"DescribeGatewayInformationOutput", + "documentation":"

A JSON object containing the following fields:

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and\n the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon\n Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request for describing a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeGatewayInformation\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 227\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayId\": \"sgw-AABB1122\",\n \"GatewayNetworkInterfaces\": [ {\"Ipv4Address\": \"10.35.69.216\"} ],\n \"GatewayState\": \"STATE_RUNNING\",\n \"GatewayTimezone\": \"GMT-8:00\"\n}\n \n \n " + }, + "DescribeMaintenanceStartTime":{ + "name":"DescribeMaintenanceStartTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeMaintenanceStartTimeInput", + "documentation":"

A JSON object containing the of the gateway.

" + }, + "output":{"shape":"DescribeMaintenanceStartTimeOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns your gateway's weekly maintenance start time including the day and time of the week.\n Note that values are in terms of the gateway's time zone.

\n \n \n Example Request\n The following example shows a request that describes a gateway's maintenance\n window.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeMaintenanceStartTime\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 136\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"HourOfDay\": 15,\n \"MinuteOfHour\": 35,\n \"DayOfWeek\": 2,\n \"Timezone\": \"GMT+7:00\"\n}\n \n \n " + }, + "DescribeSnapshotSchedule":{ + "name":"DescribeSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSnapshotScheduleInput", + "documentation":"

A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

" + }, + "output":{"shape":"DescribeSnapshotScheduleOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule\n information includes intervals at which snapshots are automatically initiated on the volume.

\n \n \n Example Request\n The following example shows a request that retrieves the snapshot schedule for a\n volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeSnapshotSchedule\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 211\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"StartAt\": 6,\n \"RecurrenceInHours\": 24,\n \"Description\": \"sgw-AABB1122:vol-AABB1122:Schedule\",\n \"Timezone\": \"GMT+7:00\"\n}\n \n \n " + }, + "DescribeStorediSCSIVolumes":{ + "name":"DescribeStorediSCSIVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeStorediSCSIVolumesInput", + "documentation":"

A JSON Object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

" + }, + "output":{"shape":"DescribeStorediSCSIVolumesOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns description of the gateway volumes specified in the request. The list of gateway volumes\n in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information\n sorted by volume ARNs.

\n \n \n Example Request\n The following example shows a request that returns a description of a volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeStorediSCSIVolumes\n{\n \"VolumeARNs\": [\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"]\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 507\n{\n \"StorediSCSIVolumes\": [\n {\n \"VolumeiSCSIAttributes\":\n {\n \"ChapEnabled\": true,\n \"NetworkInterfaceId\": \"10.243.43.207\",\n \"NetworkInterfacePort\": 3260,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n },\n \"PreservedExistingData\": false,\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/myg\n ateway/volume/vol-1122AABB\",\n \"VolumeDiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"VolumeId\": \"vol-1122AABB\",\n \"VolumeProgress\": 23.7,\n \"VolumeSizeInBytes\": 1099511627776,\n \"VolumeStatus\": \"BOOTSTRAPPING\"\n }\n ]\n}\n \n \n " + }, + "DescribeTapeArchives":{ + "name":"DescribeTapeArchives", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeTapeArchivesInput", + "documentation":"

DescribeTapeArchivesInput

" + }, + "output":{ + "shape":"DescribeTapeArchivesOutput", + "documentation":"

DescribeTapeArchivesOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

\n

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

\n \n \n Retrieve description tapes in VTS\n The following example shows a request that retrieves \n description of two tapes archived to VTS in the AWS region specified in the \n request. The request identifies the tapes by their ARN value.\n ARN value. The trailing string in the ARN is the tape barcode. \n If you don't the tape ARN, the AWS Storage Gateway returns information of \n all tapes archived to VTS.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20131028T120000Z\nx-amz-target: StorageGateway_20130630.DescribeTapeArchives\n\n{\"TapeARNs\": \n [\"arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD\", \n \"arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4\"]\n} \n\n \n \n{\"TapeArchives\": \n [\n {\"CompletionTime\": 1380308527.236, \n \"TapeARN\": \"arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD\", \n \"TapeBarcode\": \"AM08A1AD\", \n \"TapeSizeInBytes\": 107374182400, \n \"TapeStatus\": \"ARCHIVED\"}, \n {\"CompletionTime\": 1382918022.647, \n \"TapeARN\": \"arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4\", \n \"TapeBarcode\": \"AMZN01A2A4\", \n \"TapeSizeInBytes\": 429496729600, \n \"TapeStatus\": \"ARCHIVED\"}\n ]\n} \n\n \n \n " + }, + "DescribeTapeRecoveryPoints":{ + "name":"DescribeTapeRecoveryPoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeTapeRecoveryPointsInput", + "documentation":"

DescribeTapeRecoveryPointsInput

" + }, + "output":{ + "shape":"DescribeTapeRecoveryPointsOutput", + "documentation":"

DescribeTapeRecoveryPointsOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.

\n

A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent.\n If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

" + }, + "DescribeTapes":{ + "name":"DescribeTapes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeTapesInput", + "documentation":"

DescribeTapesInput

" + }, + "output":{ + "shape":"DescribeTapesOutput", + "documentation":"

DescribeTapesOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns \n a description of all virtual tapes associated with the specified gateway.

\n \n \n \n Get descriptions of specific tapes \n In the following request you obtain descriptions of tapes in \n the gateway-VTL (ExampleGatewayVTL). The request identifies specific tapes by \n specifying ARNs for the tapes. In the ARN, the trailing string, for example \"TEST04A2A1\"- is the tape barcode value. \n The string 999999999999 is your account number.\n {\"GatewayARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL\",\n \"TapeARNs\": \n [\"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1\", \n \"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0\"]\n}}}\n \n {\"Tapes\": \n [\n {\"TapeARN\": \"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1\", \n \"TapeBarcode\": \"TEST04A2A1\", \n \"TapeSizeInBytes\": 107374182400, \n \"TapeStatus\": \"AVAILABLE\"}, \n {\"TapeARN\": \"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0\", \n \"TapeBarcode\": \"TEST05A2A0\", \n \"TapeSizeInBytes\": 107374182400, \n \"TapeStatus\": \"AVAILABLE\"}\n ]\n}\n}\n \n \n " + }, + "DescribeUploadBuffer":{ + "name":"DescribeUploadBuffer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUploadBufferInput"}, + "output":{"shape":"DescribeUploadBufferOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.\n

\n

\n The response includes disk IDs that are configured as upload buffer space, and it includes\n the amount of upload buffer space allocated and used.

\n \n \n Example Request\n The following example shows a request to obtain a description of a gateway's\n working storage.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeUploadBuffer\n\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 271\n\n{\n \"DiskIds\": [\n \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"pci-0000:04:00.0-scsi-0:1:0:0\"\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"UploadBufferAllocatedInBytes\": 161061273600,\n \"UploadBufferUsedInBytes\": 0\n} \n\n \n \n " + }, + "DescribeVTLDevices":{ + "name":"DescribeVTLDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeVTLDevicesInput", + "documentation":"

DescribeVTLDevicesInput

" + }, + "output":{ + "shape":"DescribeVTLDevicesOutput", + "documentation":"

DescribeVTLDevicesOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.

\n

The list of VTL devices must be from one gateway.

\n \n \n Get descriptions of the VTL devices on a gateway\n The following example gets descriptions of all the VTL devices on a gateway (ExampleGatewayVTL). The request identifies \n the gateway by ARN. In the request, string 999999999999 is the account number associated with the AWS account sending the request. \n Note that the response shown is truncated, it shows the media changer and only two tape drives. The trailing \n string in each device ARN is the device ID. \n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20131025T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9EXAMPLE\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeVTLDevices\n{\"GatewayARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL\"}\n\n \n \n{\"GatewayARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL\", \n \"VTLDevices\": \n [\n {\"DeviceiSCSIAttributes\": \n {\"ChapEnabled\": false, \n \"NetworkInterfaceId\": \"*\", \n \"NetworkInterfacePort\": 3260, \n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger\"}, \n \"VTLDeviceARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001\", \n \"VTLDeviceProductIdentifier\": \"L700\", \n \"VTLDeviceType\": \"Medium Changer\", \n \"VTLDeviceVendor\": \"STK\"}, \n {\"DeviceiSCSIAttributes\": \n {\"ChapEnabled\": false, \n \"NetworkInterfaceId\": \"*\", \n \"NetworkInterfacePort\": 3260, \n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01\"}, \n \"VTLDeviceARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001\", \n \"VTLDeviceProductIdentifier\": \"ULT3580-TD5\", \n \"VTLDeviceType\": \"Tape Drive\", \n \"VTLDeviceVendor\": \"IBM\"}, \n {\"DeviceiSCSIAttributes\": \n {\"ChapEnabled\": false, \n \"NetworkInterfaceId\": \"*\", \n \"NetworkInterfacePort\": 3260, \n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02\"}, \n \"VTLDeviceARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002\", \n \"VTLDeviceProductIdentifier\": \"ULT3580-TD5\", \n \"VTLDeviceType\": \"Tape Drive\", \n \"VTLDeviceVendor\": \"IBM\"}\n ]\n }\n\n \n " + }, + "DescribeWorkingStorage":{ + "name":"DescribeWorkingStorage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeWorkingStorageInput", + "documentation":"

A JSON object containing the of the gateway.

" + }, + "output":{ + "shape":"DescribeWorkingStorageOutput", + "documentation":"

A JSON object containing the following fields:

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. \n This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.

\n

Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway.

\n

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

\n \n \n Example Request\n The following example shows a request to obtain a description of a gateway's working\n storage.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeWorkingStorage\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 241\n{\n \"DiskIds\": [\"pci-0000:03:00.0-scsi-0:0:0:0\", \"pci-0000:03:00.0-scsi-0:0:1:0\"],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"WorkingStorageAllocatedInBytes\": 2199023255552,\n \"WorkingStorageUsedInBytes\": 789207040\n}\n \n \n " + }, + "DisableGateway":{ + "name":"DisableGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DisableGatewayInput", + "documentation":"

DisableGatewayInput

" + }, + "output":{ + "shape":"DisableGatewayOutput", + "documentation":"

DisableGatewayOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

\n

Use this operation for a gateway-VTL that is not reachable or not functioning.

\n Once a gateway is disabled it cannot be enabled." + }, + "ListGateways":{ + "name":"ListGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListGatewaysInput", + "documentation":"

A JSON object containing zero or more of the following fields:

\n " + }, + "output":{"shape":"ListGatewaysOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation lists gateways owned by an AWS account in a region specified in the request. The returned list\n is ordered by gateway Amazon Resource Name (ARN).

\n

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you\n to optionally reduce the number of gateways returned in a response.

\n

If you have more gateways than are returned in a response-that is, the response returns only a truncated list\n of your gateways-the response contains a marker that you can specify in your next request to fetch the next\n page of gateways.

\n \n \n List Gateways\n The following example does not specify any criteria for the returned list. Note that the\n request body is \"{}\". The response returns gateways (or up to the first 100) in the\n specified region owned by the AWS account.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListGateways\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 178\n{\n \"GatewayList\": [\n {\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway2\"\n }\n ]\n}\n \n \n " + }, + "ListLocalDisks":{ + "name":"ListLocalDisks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListLocalDisksInput", + "documentation":"

A JSON object containing the of the gateway.

" + }, + "output":{"shape":"ListLocalDisksOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation returns a list of the local disks of a gateway. To specify which gateway to describe you use the\n Amazon Resource Name (ARN) of the gateway in the body of the request.

\n

The request returns all disks, specifying which are configured as working storage, stored volume or not\n configured at all.

\n \n \n Example Request\n The following example shows a request that returns information about a gateway's local\n disks.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListLocalDisks\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 398\n{\n \"Disks\": [\n {\n \"DiskAllocationType\": \"UPLOAD_BUFFER\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"DiskNode\": \"SCSI(0:0)\",\n \"DiskPath\": \"/dev/sda\",\n \"DiskSizeInBytes\": 1099511627776\n },\n {\n \"DiskAllocationType\": \"STORED_iSCSI_VOLUME\",\n \"DiskAllocationResource\": \"\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:1:0\",\n \"DiskNode\": \"SCSI(0:1)\",\n \"DiskPath\": \"/dev/sdb\",\n \"DiskSizeInBytes\": 1099511627776\n }\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n " + }, + "ListVolumeRecoveryPoints":{ + "name":"ListVolumeRecoveryPoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVolumeRecoveryPointsInput"}, + "output":{"shape":"ListVolumeRecoveryPointsOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.

\n

Each gateway-cached volume has one recovery point. A volume recovery point is a point \n in time at which all data of the volume is consistent and from which you can create a snapshot. \n To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

\n \n \n Example Request\n The following example sends a ListVolumeRecoveryPoints request to take a\n snapshot of the specified example volume.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.ListVolumeRecoveryPoints\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"VolumeRecoveryPointInfos\": [ \n { \n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeRecoveryPointTime\": \"2012-09-04T21:08:44.627Z\",\n \"VolumeSizeInBytes\": 536870912000,\n \"VolumeUsageInBytes\": 6694048\n } \n ] \n} \n\n \n \n " + }, + "ListVolumes":{ + "name":"ListVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListVolumesInput", + "documentation":"

A JSON object that contains one or more of the following fields:

\n " + }, + "output":{"shape":"ListVolumesOutput"}, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response\n includes only the volume ARNs. If you want additional volume information, use the\n DescribeStorediSCSIVolumes API.

\n

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can\n optionally specify the Limit field in the body to limit the number of volumes in the response. If\n the number of volumes returned in the response is truncated, the response includes a Marker field. You can use\n this Marker value in your subsequent request to retrieve the next set of volumes.

\n \n \n Example Request\n The List iSCSI Volumes request in this example does not specify a limit or\n marker field in the response body. The response returns the volumes\n (up to the first 100) of the gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListVolumes\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 346\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"VolumeInfos\": [\n {\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeType\": \"STORED\"\n },\n {\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-3344CCDD\",\n \"VolumeType\": \"STORED\"\n },\n ]\n}\n \n \n " + }, + "RetrieveTapeArchive":{ + "name":"RetrieveTapeArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RetrieveTapeArchiveInput", + "documentation":"

RetrieveTapeArchiveInput

" + }, + "output":{ + "shape":"RetrieveTapeArchiveOutput", + "documentation":"

RetrieveTapeArchiveOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. \n Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS.

\n

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway.

\n \n \n Retrieve a Tape\n The following example request retrieves an archived tape \n from VTS to a gateway (ExampleGatewayVTL). In the request, the \n tape is identified by its ARN. In the ARN the trailing string is the \n tape barcode. The string 999999999999 is your AWS account number. It takes about 24 hours \n for retrieval to complete. After the operation is complete, the tape \n appers in the specified gateway's virtual tape library (VTL).\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20130630.RetrieveTapeArchive\n{\n \"TapeARN\": \"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF\",\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:999999999999:gateway/ExampleGatewayVTL\"\n }\n \n \n{\"TapeARN\": \"arn:aws:storagegateway:us-east-1:204469490176:tape/TEST0AA2AF\"}\n \n \n " + }, + "RetrieveTapeRecoveryPoint":{ + "name":"RetrieveTapeRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RetrieveTapeRecoveryPointInput", + "documentation":"

RetrieveTapeRecoveryPointInput

" + }, + "output":{ + "shape":"RetrieveTapeRecoveryPointOutput", + "documentation":"

RetrieveTapeRecoveryPointOutput

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

Retrieves the recovery point for the specified virtual tape.

\n

A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent.\n If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

\n The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. \n The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points." + }, + "ShutdownGateway":{ + "name":"ShutdownGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ShutdownGatewayInput", + "documentation":"

A JSON object containing the of the gateway to shut down.

" + }, + "output":{ + "shape":"ShutdownGatewayOutput", + "documentation":"

A JSON object containing the of the gateway that was shut down.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN)\n of the gateway in the body of your request.

\n

The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM)\n and not the VM.

\n If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM\n to avoid unpredictable conditions.\n

After the gateway is shutdown, you cannot call any other API except StartGateway,\n DescribeGatewayInformation, and ListGateways. For more information, see\n ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there\n are no snapshots taken.

\n When you make a shutdown request, you will get a 200 OK success response immediately. However,\n it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to\n check the status. For more information, see ActivateGateway.\n

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay\n software charges associated with the gateway.

\n \n \n Example Request\n The following example shows a request that shuts down a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ShutdownGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n " + }, + "StartGateway":{ + "name":"StartGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"StartGatewayInput", + "documentation":"

A JSON object containing the of the gateway to start.

" + }, + "output":{ + "shape":"StartGatewayOutput", + "documentation":"

A JSON object containing the of the gateway that was restarted.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation starts a gateway that you previously shut down (see ShutdownGateway). After the gateway\n starts, you can then make other API calls, your applications can read from or write to the gateway's storage\n volumes and you will be able to take snapshot backups.

\n When you make a request, you will get a 200 OK success response immediately. However, it might take some\n time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before\n making any additional API calls. For more information, see ActivateGateway.\n

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request that starts a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.StartGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n " + }, + "UpdateBandwidthRateLimit":{ + "name":"UpdateBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateBandwidthRateLimitInput", + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "output":{ + "shape":"UpdateBandwidthRateLimitOutput", + "documentation":"

A JSON object containing the of the gateway whose throttle information was updated.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download\n bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate\n limit remains.

\n

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not\n have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

\n

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request that returns the bandwidth throttle properties of a\n gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"AverageUploadRateLimitInBitsPerSec\": 51200,\n \"AverageDownloadRateLimitInBitsPerSec\": 102400\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n " + }, + "UpdateChapCredentials":{ + "name":"UpdateChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateChapCredentialsInput", + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "output":{ + "shape":"UpdateChapCredentialsOutput", + "documentation":"

A JSON object containing the following fields:

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI\n target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

\n \n

When you update CHAP credentials, all existing connections on the target are\n closed and initiators must reconnect with the new credentials.

\n \n \n \n \n Example Request\n The following example shows a request that updates CHAP credentials for an iSCSI\n target.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"SecretToAuthenticateInitiator\": \"111111111111\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\",\n \"SecretToAuthenticateTarget\": \"222222222222\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 161\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n \n \n " + }, + "UpdateGatewayInformation":{ + "name":"UpdateGatewayInformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewayInformationInput"}, + "output":{ + "shape":"UpdateGatewayInformationOutput", + "documentation":"

A JSON object containing the of the gateway that was updated.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which\n gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request that updates the name of a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateGatewayInformation\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayName\" \"mygateway2\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 81\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway2\"\n}\n \n \n " + }, + "UpdateGatewaySoftwareNow":{ + "name":"UpdateGatewaySoftwareNow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateGatewaySoftwareNowInput", + "documentation":"

A JSON object containing the of the gateway to update.

" + }, + "output":{ + "shape":"UpdateGatewaySoftwareNowOutput", + "documentation":"

A JSON object containing the of the gateway that was updated.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software\n update.

\n When you make this request, you get a 200 OK success response immediately. However, it might\n take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway\n is in the STATE_RUNNING state.\n A software update forces a system restart of your gateway. You can minimize the chance of any disruption to\n your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI\n Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.\n \n \n Example Request\n The following example shows a request that initiates a gateway VM update.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateGatewaySoftwareNow\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n " + }, + "UpdateMaintenanceStartTime":{ + "name":"UpdateMaintenanceStartTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateMaintenanceStartTimeInput", + "documentation":"

A JSON object containing the following fields:

\n " + }, + "output":{ + "shape":"UpdateMaintenanceStartTimeOutput", + "documentation":"

A JSON object containing the of the gateway whose maintenance start time is updated.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation updates a gateway's weekly maintenance start time information, including day and time of the\n week. The maintenance time is the time in your gateway's time zone.

\n \n \n Example Request\n The following example shows a request that updates the maintenance start time of\n mygateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateMaintenanceStartTime\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"HourOfDay\": 0,\n \"MinuteOfHour\": 30,\n \"DayOfWeek\": 2\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n\"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n \n " + }, + "UpdateSnapshotSchedule":{ + "name":"UpdateSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateSnapshotScheduleInput", + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "output":{ + "shape":"UpdateSnapshotScheduleOutput", + "documentation":"

A JSON object containing the of the updated storage volume.

" + }, + "errors":[ + { + "shape":"InvalidGatewayRequestException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + { + "shape":"InternalServerError", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + } + ], + "documentation":"

This operation updates a snapshot schedule configured for a gateway volume.

\n

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume.\n You can use this API to change the snapshot schedule configured for the volume.

\n

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the\n schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of\n snapshots.

\n \n \n Example Request\n The following example shows a request that updates a snapshot schedule.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateSnapshotSchedule\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"StartAt\": 0,\n \"RecurrenceInHours\": 1,\n \"Description\": \"hourly snapshot\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 99\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n \n \n " + } + }, + "shapes":{ + "ActivateGatewayInput":{ + "type":"structure", + "required":[ + "ActivationKey", + "GatewayName", + "GatewayTimezone", + "GatewayRegion" + ], + "members":{ + "ActivationKey":{ + "shape":"ActivationKey", + "documentation":"

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects\n enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key\n for your gateway in the query string parameter activationKey. It may also\n include other activation-related parameters, however, these are merely\n defaults -- the arguments you pass to the ActivateGateway API call\n determine the actual configuration of your gateway.

" + }, + "GatewayName":{"shape":"GatewayName"}, + "GatewayTimezone":{ + "shape":"GatewayTimezone", + "documentation":"

One of the values that indicates the time zone you want to set for the gateway. The time\n zone is used, for example, for scheduling snapshots and your gateway's maintenance\n schedule.

" + }, + "GatewayRegion":{ + "shape":"RegionId", + "documentation":"

One of the values that indicates the region where you want to store the snapshot\n backups. The gateway region specified must be the same region as the\n region in your Host header in the request. For more information about available regions \n and endpoints for AWS Storage Gateway, see Regions and Endpoints in\n the Amazon Web Services Glossary.

\n

Valid Values: \"us-east-1\", \"us-west-1\", \"us-west-2\", \"eu-west-1\", \"ap-northeast-1\", \"ap-southest-1\",\n \"sa-east-1\"

" + }, + "GatewayType":{ + "shape":"GatewayType", + "documentation":"

One of the values that defines the type of gateway to activate. The type specified is\n critical to all later functions of the gateway and cannot be changed after activation. The\n default value is STORED.

" + }, + "TapeDriveType":{"shape":"TapeDriveType"}, + "MediumChangerType":{"shape":"MediumChangerType"} + }, + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "ActivateGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of\n information such as your account, gateway name, and region. This ARN is\n used to reference the gateway in other API operations as well as\n resource-based authorization.

" + }, + "ActivationKey":{ + "type":"string", + "min":1, + "max":50 + }, + "AddCacheInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"} + } + }, + "AddCacheOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "AddUploadBufferInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"} + } + }, + "AddUploadBufferOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "AddWorkingStorageInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{ + "shape":"DiskIds", + "documentation":"

An array of strings that identify disks that are to be configured as working storage. Each string have a\n minimum length of 1 and maximum length of 300. You can get the disk IDs from\n the ListLocalDisks API.

" + } + }, + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "AddWorkingStorageOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway for which working storage was configured.

" + }, + "BandwidthDownloadRateLimit":{ + "type":"long", + "min":102400 + }, + "BandwidthType":{ + "type":"string", + "min":3, + "max":25 + }, + "BandwidthUploadRateLimit":{ + "type":"long", + "min":51200 + }, + "CachediSCSIVolume":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeId":{"shape":"VolumeId"}, + "VolumeType":{"shape":"VolumeType"}, + "VolumeStatus":{"shape":"VolumeStatus"}, + "VolumeSizeInBytes":{"shape":"long"}, + "VolumeProgress":{"shape":"DoubleObject"}, + "SourceSnapshotId":{"shape":"SnapshotId"}, + "VolumeiSCSIAttributes":{"shape":"VolumeiSCSIAttributes"} + } + }, + "CachediSCSIVolumes":{ + "type":"list", + "member":{"shape":"CachediSCSIVolume"} + }, + "CancelArchivalInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.

" + } + }, + "documentation":"

CancelArchivalInput

" + }, + "CancelArchivalOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.

" + } + }, + "documentation":"

CancelArchivalOutput

" + }, + "CancelRetrievalInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

" + } + }, + "documentation":"

CancelRetrievalInput

" + }, + "CancelRetrievalOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

" + } + }, + "documentation":"

CancelRetrievalOutput

" + }, + "ChapCredentials":{ + "type":"list", + "member":{"shape":"ChapInfo"} + }, + "ChapInfo":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

The Amazon Resource Name (ARN) of the volume.

\n

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" + }, + "SecretToAuthenticateInitiator":{ + "shape":"ChapSecret", + "documentation":"

The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.

" + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

The iSCSI initiator that connects to the target.

" + }, + "SecretToAuthenticateTarget":{ + "shape":"ChapSecret", + "documentation":"

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows\n client).

" + } + }, + "documentation":"

Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between\n your gateway and iSCSI initiators.

" + }, + "ChapSecret":{ + "type":"string", + "min":12, + "max":16 + }, + "ClientToken":{ + "type":"string", + "min":5, + "max":100 + }, + "CreateCachediSCSIVolumeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "VolumeSizeInBytes", + "TargetName", + "NetworkInterfaceId", + "ClientToken" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VolumeSizeInBytes":{"shape":"long"}, + "SnapshotId":{"shape":"SnapshotId"}, + "TargetName":{"shape":"TargetName"}, + "NetworkInterfaceId":{"shape":"NetworkInterfaceId"}, + "ClientToken":{"shape":"ClientToken"} + } + }, + "CreateCachediSCSIVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "TargetARN":{"shape":"TargetARN"} + } + }, + "CreateSnapshotFromVolumeRecoveryPointInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "SnapshotDescription" + ], + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "SnapshotDescription":{"shape":"SnapshotDescription"} + } + }, + "CreateSnapshotFromVolumeRecoveryPointOutput":{ + "type":"structure", + "members":{ + "SnapshotId":{"shape":"SnapshotId"}, + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeRecoveryPointTime":{"shape":"string"} + } + }, + "CreateSnapshotInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "SnapshotDescription" + ], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

" + }, + "SnapshotDescription":{ + "shape":"SnapshotDescription", + "documentation":"

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot\n Details pane, Description field

" + } + }, + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "CreateSnapshotOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

" + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot\n (CreateStorediSCSIVolume).

" + } + }, + "documentation":"

A JSON object containing the following fields:

" + }, + "CreateStorediSCSIVolumeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskId", + "PreserveExistingData", + "TargetName", + "NetworkInterfaceId" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskId":{ + "shape":"DiskId", + "documentation":"

The unique identifier for the gateway local disk that is configured as a stored volume. Use\n ListLocalDisks to list disk IDs for a gateway.

" + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field\n if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list\n snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

" + }, + "PreserveExistingData":{ + "shape":"boolean", + "documentation":"

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field\n as false creates an empty volume.

\n

Valid Values: true, false

" + }, + "TargetName":{ + "shape":"TargetName", + "documentation":"

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.\n For example, specifying TargetName as myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The\n target name must be unique across all volumes of a gateway.

" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use\n DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

\n

Valid Values: A valid IP address.

" + } + }, + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "CreateStorediSCSIVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

The Amazon Resource Name (ARN) of the configured volume.

" + }, + "VolumeSizeInBytes":{ + "shape":"long", + "documentation":"

The size of the volume in bytes.

" + }, + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to\n connect to the target.

" + } + }, + "documentation":"

A JSON object containing the following fields:

" + }, + "CreateTapesInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeSizeInBytes", + "ClientToken", + "NumTapesToCreate", + "TapeBarcodePrefix" + ], + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

The unique Amazon Resource Name(ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of\n gateways for your account and region.

" + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

The size, in bytes, of the virtual tapes you want to create.

\n The size must be gigabyte (1024*1024*1024 byte) aligned." + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

A unique identifier that you use to retry a request. If you retry \n a request, use the same ClientToken you specified in the initial request.

\n Using the same ClientToken prevents creating the tape multiple times." + }, + "NumTapesToCreate":{ + "shape":"NumTapesToCreate", + "documentation":"

The number of virtual tapes you want to create.

" + }, + "TapeBarcodePrefix":{ + "shape":"TapeBarcodePrefix", + "documentation":"

A prefix you append to the barcode of the virtual tape you are creating. This makes a barcode unique.

\n The prefix must be 1 to 4 characters in length and must be upper-case letters A-Z." + } + }, + "documentation":"

CreateTapesInput

" + }, + "CreateTapesOutput":{ + "type":"structure", + "members":{ + "TapeARNs":{ + "shape":"TapeARNs", + "documentation":"

A list of unique Amazon Resource Named (ARN) the represents the virtual tapes that were created.

" + } + }, + "documentation":"

CreateTapeOutput

" + }, + "DayOfWeek":{ + "type":"integer", + "min":0, + "max":6 + }, + "DeleteBandwidthRateLimitInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "BandwidthType" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "BandwidthType":{"shape":"BandwidthType"} + } + }, + "DeleteBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway whose bandwidth rate information was deleted.

" + }, + "DeleteChapCredentialsInput":{ + "type":"structure", + "required":[ + "TargetARN", + "InitiatorName" + ], + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

" + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

The iSCSI initiator that connects to the target.

" + } + }, + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "DeleteChapCredentialsOutput":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

The Amazon Resource Name (ARN) of the target.

" + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

The iSCSI initiator that connects to the target.

" + } + }, + "documentation":"

A JSON object containing the following fields:

" + }, + "DeleteGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway to delete.

" + }, + "DeleteGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the deleted gateway.

" + }, + "DeleteSnapshotScheduleInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "DeleteSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "DeleteTapeArchiveInput":{ + "type":"structure", + "required":["TapeARN"], + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).

" + } + }, + "documentation":"

DeleteTapeArchiveInput

" + }, + "DeleteTapeArchiveOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).

" + } + }, + "documentation":"

DeleteTapeArchiveOutput

" + }, + "DeleteTapeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of\n gateways for your account and region.

" + }, + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape to delete.

" + } + }, + "documentation":"

DeleteTapeInput

" + }, + "DeleteTapeOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the deleted virtual tape.

" + } + }, + "documentation":"

DeleteTapeOutput

" + }, + "DeleteVolumeInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

" + } + }, + "documentation":"

A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

" + }, + "DeleteVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the\n request.

" + } + }, + "documentation":"

A JSON object containing the of the storage volume that was deleted

" + }, + "DescribeBandwidthRateLimitInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway.

" + }, + "DescribeBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "AverageUploadRateLimitInBitsPerSec":{ + "shape":"BandwidthUploadRateLimit", + "documentation":"

The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the\n upload rate limit is not set.

" + }, + "AverageDownloadRateLimitInBitsPerSec":{ + "shape":"BandwidthDownloadRateLimit", + "documentation":"

The average download bandwidth rate limit in bits per second. This field does not appear in the response if the\n download rate limit is not set.

" + } + }, + "documentation":"

A JSON object containing the following fields:

" + }, + "DescribeCacheInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeCacheOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"}, + "CacheAllocatedInBytes":{"shape":"long"}, + "CacheUsedPercentage":{"shape":"double"}, + "CacheDirtyPercentage":{"shape":"double"}, + "CacheHitPercentage":{"shape":"double"}, + "CacheMissPercentage":{"shape":"double"} + } + }, + "DescribeCachediSCSIVolumesInput":{ + "type":"structure", + "required":["VolumeARNs"], + "members":{ + "VolumeARNs":{"shape":"VolumeARNs"} + } + }, + "DescribeCachediSCSIVolumesOutput":{ + "type":"structure", + "members":{ + "CachediSCSIVolumes":{ + "shape":"CachediSCSIVolumes", + "documentation":"

An array of objects where each object contains metadata about one cached volume.

" + } + }, + "documentation":"

A JSON object containing the following fields:

" + }, + "DescribeChapCredentialsInput":{ + "type":"structure", + "required":["TargetARN"], + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

" + } + }, + "documentation":"

A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

" + }, + "DescribeChapCredentialsOutput":{ + "type":"structure", + "members":{ + "ChapCredentials":{ + "shape":"ChapCredentials", + "documentation":"

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

\n " + } + }, + "documentation":"

A JSON object containing a .

" + }, + "DescribeGatewayInformationInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway.

" + }, + "DescribeGatewayInformationOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayId":{ + "shape":"GatewayId", + "documentation":"

The gateway ID.

" + }, + "GatewayTimezone":{ + "shape":"GatewayTimezone", + "documentation":"

One of the values that indicates the time zone configured for the gateway.

" + }, + "GatewayState":{ + "shape":"GatewayState", + "documentation":"

One of the values that indicates the operating state of the gateway.

" + }, + "GatewayNetworkInterfaces":{ + "shape":"GatewayNetworkInterfaces", + "documentation":"

A NetworkInterface array that contains descriptions of the gateway network interfaces.

" + }, + "GatewayType":{ + "shape":"GatewayType", + "documentation":"

TBD

" + }, + "NextUpdateAvailabilityDate":{ + "shape":"NextUpdateAvailabilityDate", + "documentation":"

The date at which an update to the gateway is available. This date is in the time zone of the gateway. If the\n gateway is not available for an update this field is not returned in the response.

\n " + } + }, + "documentation":"

A JSON object containing the following fields:

" + }, + "DescribeMaintenanceStartTimeInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway.

" + }, + "DescribeMaintenanceStartTimeOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "HourOfDay":{"shape":"HourOfDay"}, + "MinuteOfHour":{"shape":"MinuteOfHour"}, + "DayOfWeek":{"shape":"DayOfWeek"}, + "Timezone":{"shape":"GatewayTimezone"} + } + }, + "DescribeSnapshotScheduleInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway\n volumes.

" + } + }, + "documentation":"

A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

" + }, + "DescribeSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "StartAt":{"shape":"HourOfDay"}, + "RecurrenceInHours":{"shape":"RecurrenceInHours"}, + "Description":{"shape":"Description"}, + "Timezone":{"shape":"GatewayTimezone"} + } + }, + "DescribeStorediSCSIVolumesInput":{ + "type":"structure", + "required":["VolumeARNs"], + "members":{ + "VolumeARNs":{ + "shape":"VolumeARNs", + "documentation":"

An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the\n specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a\n gateway.

" + } + }, + "documentation":"

A JSON Object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

" + }, + "DescribeStorediSCSIVolumesOutput":{ + "type":"structure", + "members":{ + "StorediSCSIVolumes":{"shape":"StorediSCSIVolumes"} + } + }, + "DescribeTapeArchivesInput":{ + "type":"structure", + "members":{ + "TapeARNs":{ + "shape":"TapeARNs", + "documentation":"

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

An opaque string that indicates the position at which to begin describing virtual tapes.

" + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

Specifies that the number of virtual tapes descried be limited to the specified number.

" + } + }, + "documentation":"

DescribeTapeArchivesInput

" + }, + "DescribeTapeArchivesOutput":{ + "type":"structure", + "members":{ + "TapeArchives":{ + "shape":"TapeArchives", + "documentation":"

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. \n The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

An opaque string that indicates the position at which the virtual tapes that were fetched for description ended.\n Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.\n

" + } + }, + "documentation":"

DescribeTapeArchivesOutput

" + }, + "DescribeTapeRecoveryPointsInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{ + "shape":"Marker", + "documentation":"

An opaque string that indicates the position at which to begin describing the virtual tape recovery \n points.

" + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

Specifies that the number of virtual tape recovery points that are described be limited to the specified \n number.

" + } + }, + "documentation":"

DescribeTapeRecoveryPointsInput

" + }, + "DescribeTapeRecoveryPointsOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeRecoveryPointInfos":{ + "shape":"TapeRecoveryPointInfos", + "documentation":"

An array of TapeRecoveryPointInfos that are available for the specified gateway.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

An opaque string that indicates the position at which the virtual tape recovery points that were \n listed for description ended.

\n

Use this marker in your next request to list the next set of virtual tape recovery points in the list. \n If there are no more recovery points to describe, this field does not appear in the response.

" + } + }, + "documentation":"

DescribeTapeRecoveryPointsOutput

" + }, + "DescribeTapesInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARNs":{ + "shape":"TapeARNs", + "documentation":"

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. \n If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

\n

If not specified, the first page of results is retrieved.

" + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

Specifies that the number of virtual tapes described be limited to the specified number.

\n Amazon Web Services may impose its own limit, if this field is not set." + } + }, + "documentation":"

DescribeTapesInput

" + }, + "DescribeTapesOutput":{ + "type":"structure", + "members":{ + "Tapes":{ + "shape":"Tapes", + "documentation":"

An array of virtual tape descriptions.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

\n

If a response does not contain a marker, then there are no more results to be retrieved.

" + } + }, + "documentation":"

DescribeTapesOutput

" + }, + "DescribeUploadBufferInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeUploadBufferOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"}, + "UploadBufferUsedInBytes":{"shape":"long"}, + "UploadBufferAllocatedInBytes":{"shape":"long"} + } + }, + "DescribeVTLDevicesInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VTLDeviceARNs":{ + "shape":"VTLDeviceARNs", + "documentation":"

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

\n All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway." + }, + "Marker":{ + "shape":"Marker", + "documentation":"

An opaque string that indicates the position at which to begin describing the VTL devices.

" + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

Specifies that the number of VTL devices described be limited to the specified number.

" + } + }, + "documentation":"

DescribeVTLDevicesInput

" + }, + "DescribeVTLDevicesOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VTLDevices":{ + "shape":"VTLDevices", + "documentation":"

An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

An opaque string that indicates the position at which the VTL devices that were fetched for description ended. \n Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

" + } + }, + "documentation":"

DescribeVTLDevicesOutput

" + }, + "DescribeWorkingStorageInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway.

" + }, + "DescribeWorkingStorageOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{ + "shape":"DiskIds", + "documentation":"

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is\n specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as\n working storage, then the DiskIds array is empty.

" + }, + "WorkingStorageUsedInBytes":{ + "shape":"long", + "documentation":"

The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway,\n this field returns 0.

" + }, + "WorkingStorageAllocatedInBytes":{ + "shape":"long", + "documentation":"

The total working storage in bytes allocated for the gateway. If no working storage is configured for the\n gateway, this field returns 0.

" + } + }, + "documentation":"

A JSON object containing the following fields:

" + }, + "Description":{ + "type":"string", + "min":1, + "max":255 + }, + "DeviceiSCSIAttributes":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.

" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The network interface identifier of the VTL device.

" + }, + "NetworkInterfacePort":{ + "shape":"integer", + "documentation":"

The port used to communicate with iSCSI VTL device targets.

" + }, + "ChapEnabled":{ + "shape":"boolean", + "documentation":"

Indicates whether mutual CHAP is enabled for the iSCSI target.

" + } + }, + "documentation":"

Lists iSCSI information about a VTL device.

" + }, + "DisableGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

DisableGatewayInput

" + }, + "DisableGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

The unique Amazon Resource Name of the disabled gateway.

" + } + }, + "documentation":"

DisableGatewayOutput

" + }, + "Disk":{ + "type":"structure", + "members":{ + "DiskId":{"shape":"DiskId"}, + "DiskPath":{"shape":"string"}, + "DiskNode":{"shape":"string"}, + "DiskSizeInBytes":{"shape":"long"}, + "DiskAllocationType":{"shape":"DiskAllocationType"}, + "DiskAllocationResource":{"shape":"string"} + } + }, + "DiskAllocationType":{ + "type":"string", + "min":3, + "max":100 + }, + "DiskId":{ + "type":"string", + "min":1, + "max":300 + }, + "DiskIds":{ + "type":"list", + "member":{"shape":"DiskId"} + }, + "Disks":{ + "type":"list", + "member":{"shape":"Disk"} + }, + "DoubleObject":{"type":"double"}, + "ErrorCode":{ + "type":"string", + "enum":[ + "ActivationKeyExpired", + "ActivationKeyInvalid", + "ActivationKeyNotFound", + "GatewayInternalError", + "GatewayNotConnected", + "GatewayNotFound", + "GatewayProxyNetworkConnectionBusy", + "AuthenticationFailure", + "BandwidthThrottleScheduleNotFound", + "Blocked", + "CannotExportSnapshot", + "ChapCredentialNotFound", + "DiskAlreadyAllocated", + "DiskDoesNotExist", + "DiskSizeGreaterThanVolumeMaxSize", + "DiskSizeLessThanVolumeSize", + "DiskSizeNotGigAligned", + "DuplicateCertificateInfo", + "DuplicateSchedule", + "EndpointNotFound", + "IAMNotSupported", + "InitiatorInvalid", + "InitiatorNotFound", + "InternalError", + "InvalidGateway", + "InvalidEndpoint", + "InvalidParameters", + "InvalidSchedule", + "LocalStorageLimitExceeded", + "LunAlreadyAllocated ", + "LunInvalid", + "MaximumContentLengthExceeded", + "MaximumTapeCartridgeCountExceeded", + "MaximumVolumeCountExceeded", + "NetworkConfigurationChanged", + "NoDisksAvailable", + "NotImplemented", + "NotSupported", + "OperationAborted", + "OutdatedGateway", + "ParametersNotImplemented", + "RegionInvalid", + "RequestTimeout", + "ServiceUnavailable", + "SnapshotDeleted", + "SnapshotIdInvalid", + "SnapshotInProgress", + "SnapshotNotFound", + "SnapshotScheduleNotFound", + "StagingAreaFull", + "StorageFailure", + "TapeCartridgeNotFound", + "TargetAlreadyExists", + "TargetInvalid", + "TargetNotFound", + "UnauthorizedOperation", + "VolumeAlreadyExists", + "VolumeIdInvalid", + "VolumeInUse", + "VolumeNotFound", + "VolumeNotReady" + ] + }, + "GatewayARN":{ + "type":"string", + "min":50, + "max":500, + "documentation":"

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

" + }, + "GatewayId":{ + "type":"string", + "min":12, + "max":30 + }, + "GatewayInfo":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayType":{"shape":"GatewayType"}, + "GatewayOperationalState":{"shape":"GatewayOperationalState"} + } + }, + "GatewayName":{ + "type":"string", + "min":2, + "max":255, + "pattern":"^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$", + "documentation":"

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which\n is what you use as an input to other operations.

" + }, + "GatewayNetworkInterfaces":{ + "type":"list", + "member":{"shape":"NetworkInterface"} + }, + "GatewayOperationalState":{ + "type":"string", + "min":2, + "max":25 + }, + "GatewayState":{ + "type":"string", + "min":2, + "max":25 + }, + "GatewayTimezone":{ + "type":"string", + "min":3, + "max":10 + }, + "GatewayType":{ + "type":"string", + "min":2, + "max":20 + }, + "Gateways":{ + "type":"list", + "member":{"shape":"GatewayInfo"} + }, + "HourOfDay":{ + "type":"integer", + "min":0, + "max":23 + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

A human-readable message describing the error that occurred.

" + }, + "error":{ + "shape":"StorageGatewayError", + "documentation":"

A StorageGatewayError that provides more detail about the cause of the error.

" + } + }, + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

An internal server error has occurred during the request. See the error and message fields for more\n information.

" + }, + "InvalidGatewayRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

A human-readable message describing the error that occurred.

" + }, + "error":{ + "shape":"StorageGatewayError", + "documentation":"

A StorageGatewayError that provides more detail about the cause of the error.

" + } + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An exception occurred because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

" + }, + "IqnName":{ + "type":"string", + "min":1, + "max":255, + "pattern":"[0-9a-z:.-]+" + }, + "ListGatewaysInput":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

An opaque string that indicates the position at which to begin the returned list of gateways.

" + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

Specifies that the list of gateways returned be limited to the specified number of items.

" + } + }, + "documentation":"

A JSON object containing zero or more of the following fields:

\n " + }, + "ListGatewaysOutput":{ + "type":"structure", + "members":{ + "Gateways":{"shape":"Gateways"}, + "Marker":{"shape":"Marker"} + } + }, + "ListLocalDisksInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway.

" + }, + "ListLocalDisksOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Disks":{"shape":"Disks"} + } + }, + "ListVolumeRecoveryPointsInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ListVolumeRecoveryPointsOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VolumeRecoveryPointInfos":{"shape":"VolumeRecoveryPointInfos"} + } + }, + "ListVolumesInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{ + "shape":"Marker", + "documentation":"

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the\n response of a previous List iSCSI Volumes request.

" + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

Specifies that the list of volumes returned be limited to the specified number of items.

" + } + }, + "documentation":"

A JSON object that contains one or more of the following fields:

\n " + }, + "ListVolumesOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{"shape":"Marker"}, + "VolumeInfos":{"shape":"VolumeInfos"} + } + }, + "Marker":{ + "type":"string", + "min":1, + "max":1000 + }, + "MediumChangerType":{ + "type":"string", + "min":2, + "max":50 + }, + "MinuteOfHour":{ + "type":"integer", + "min":0, + "max":59 + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "Ipv4Address":{ + "shape":"string", + "documentation":"

The Internet Protocol version 4 (IPv4) address of the interface.

" + }, + "MacAddress":{ + "shape":"string", + "documentation":"

The Media Access Control (MAC) address of the interface.

\n This is currently unsupported and will not be returned in output." + }, + "Ipv6Address":{ + "shape":"string", + "documentation":"

The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

" + } + }, + "documentation":"

Describes a gateway's network interface.

" + }, + "NetworkInterfaceId":{ + "type":"string", + "pattern":"\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z" + }, + "NextUpdateAvailabilityDate":{ + "type":"string", + "min":1, + "max":25 + }, + "NumTapesToCreate":{ + "type":"integer", + "min":1, + "max":10 + }, + "PositiveIntObject":{ + "type":"integer", + "min":1 + }, + "RecurrenceInHours":{ + "type":"integer", + "min":1, + "max":24 + }, + "RegionId":{ + "type":"string", + "min":1, + "max":25 + }, + "RetrieveTapeArchiveInput":{ + "type":"structure", + "required":[ + "TapeARN", + "GatewayARN" + ], + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

" + }, + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n

You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.

" + } + }, + "documentation":"

RetrieveTapeArchiveInput

" + }, + "RetrieveTapeArchiveOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the retrieved virtual tape.

" + } + }, + "documentation":"

RetrieveTapeArchiveOutput

" + }, + "RetrieveTapeRecoveryPointInput":{ + "type":"structure", + "required":[ + "TapeARN", + "GatewayARN" + ], + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.

" + }, + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

RetrieveTapeRecoveryPointInput

" + }, + "RetrieveTapeRecoveryPointOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.

" + } + }, + "documentation":"

RetrieveTapeRecoveryPointOutput

" + }, + "ShutdownGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway to shut down.

" + }, + "ShutdownGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway that was shut down.

" + }, + "SnapshotDescription":{ + "type":"string", + "min":1, + "max":255 + }, + "SnapshotId":{ + "type":"string", + "pattern":"\\Asnap-[0-9a-fA-F]{8}\\z" + }, + "StartGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway to start.

" + }, + "StartGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway that was restarted.

" + }, + "StorageGatewayError":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

Additional information about the error.

" + }, + "errorDetails":{ + "shape":"errorDetails", + "documentation":"

Human-readable text that provides detail about the error that occurred.

" + } + }, + "documentation":"

Provides additional information about an error that was returned by the service as an\n or. See the errorCode and\n errorDetails members for more information about the error.

" + }, + "StorediSCSIVolume":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeId":{"shape":"VolumeId"}, + "VolumeType":{"shape":"VolumeType"}, + "VolumeStatus":{"shape":"VolumeStatus"}, + "VolumeSizeInBytes":{"shape":"long"}, + "VolumeProgress":{"shape":"DoubleObject"}, + "VolumeDiskId":{"shape":"DiskId"}, + "SourceSnapshotId":{"shape":"SnapshotId"}, + "PreservedExistingData":{"shape":"boolean"}, + "VolumeiSCSIAttributes":{"shape":"VolumeiSCSIAttributes"} + } + }, + "StorediSCSIVolumes":{ + "type":"list", + "member":{"shape":"StorediSCSIVolume"} + }, + "Tape":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape.

" + }, + "TapeBarcode":{ + "shape":"TapeBarcode", + "documentation":"

The barcode that identifies a specific virtual tape.

" + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

The size, in bytes, of the virtual tape.

" + }, + "TapeStatus":{ + "shape":"TapeStatus", + "documentation":"

The current state of the virtual tape.

" + }, + "VTLDevice":{ + "shape":"VTLDeviceARN", + "documentation":"

The virtual tape library (VTL) device that the virtual tape is associated with.

" + }, + "Progress":{ + "shape":"DoubleObject", + "documentation":"

For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

\n

Range: 0 (not started) to 100 (complete).

" + } + }, + "documentation":"

Describes a virtual tape object.

" + }, + "TapeARN":{ + "type":"string", + "min":50, + "max":500 + }, + "TapeARNs":{ + "type":"list", + "member":{"shape":"TapeARN"} + }, + "TapeArchive":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of an archived virtual tape.

" + }, + "TapeBarcode":{ + "shape":"TapeBarcode", + "documentation":"

The barcode that identifies the archived virtual tape.

" + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

The size, in bytes, of the archived virtual tape.

" + }, + "CompletionTime":{ + "shape":"Time", + "documentation":"

The time that the archiving of the virtual tape was completed.

\n

The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

" + }, + "RetrievedTo":{ + "shape":"GatewayARN", + "documentation":"

The Amazon Resource Name (ARN) of the gateway-VTL that the virtual tape is being retrieved to.

\n

The virtual tape is retrieved from the virtual tape shelf (VTS).

" + }, + "TapeStatus":{ + "shape":"TapeArchiveStatus", + "documentation":"

The current state of the archived virtual tape.

" + } + }, + "documentation":"

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

" + }, + "TapeArchiveStatus":{"type":"string"}, + "TapeArchives":{ + "type":"list", + "member":{"shape":"TapeArchive"} + }, + "TapeBarcode":{ + "type":"string", + "min":8, + "max":16, + "pattern":"^[A-Z0-9]*$" + }, + "TapeBarcodePrefix":{ + "type":"string", + "min":1, + "max":4, + "pattern":"^[A-Z]*$" + }, + "TapeDriveType":{ + "type":"string", + "min":2, + "max":50 + }, + "TapeRecoveryPointInfo":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

The Amazon Resource Name (ARN) of the virtual tape.

" + }, + "TapeRecoveryPointTime":{ + "shape":"Time", + "documentation":"

The time when the point-in-time view of the virtual tape was replicated for later recovery.

\n

The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

" + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

The size, in bytes, of the virtual tapes to recover.

" + }, + "TapeStatus":{"shape":"TapeRecoveryPointStatus"} + }, + "documentation":"

Describes a recovery point.

" + }, + "TapeRecoveryPointInfos":{ + "type":"list", + "member":{"shape":"TapeRecoveryPointInfo"} + }, + "TapeRecoveryPointStatus":{"type":"string"}, + "TapeSize":{ + "type":"long", + "min":107374182400, + "max":2748779069440 + }, + "TapeStatus":{"type":"string"}, + "Tapes":{ + "type":"list", + "member":{"shape":"Tape"} + }, + "TargetARN":{ + "type":"string", + "min":50, + "max":800 + }, + "TargetName":{ + "type":"string", + "min":1, + "max":200, + "pattern":"^[-\\.;a-z0-9]+$" + }, + "Time":{"type":"timestamp"}, + "UpdateBandwidthRateLimitInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "AverageUploadRateLimitInBitsPerSec":{ + "shape":"BandwidthUploadRateLimit", + "documentation":"

The average upload bandwidth rate limit in bits per second.

" + }, + "AverageDownloadRateLimitInBitsPerSec":{ + "shape":"BandwidthDownloadRateLimit", + "documentation":"

The average download bandwidth rate limit in bits per second.

" + } + }, + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "UpdateBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway whose throttle information was updated.

" + }, + "UpdateChapCredentialsInput":{ + "type":"structure", + "required":[ + "TargetARN", + "SecretToAuthenticateInitiator", + "InitiatorName" + ], + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation\n to return to retrieve the TargetARN for specified VolumeARN.

" + }, + "SecretToAuthenticateInitiator":{ + "shape":"ChapSecret", + "documentation":"

The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the\n target.

" + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

The iSCSI initiator that connects to the target.

" + }, + "SecretToAuthenticateTarget":{ + "shape":"ChapSecret", + "documentation":"

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows\n client).

" + } + }, + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "UpdateChapCredentialsOutput":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

" + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.

" + } + }, + "documentation":"

A JSON object containing the following fields:

" + }, + "UpdateGatewayInformationInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayName":{"shape":"GatewayName"}, + "GatewayTimezone":{"shape":"GatewayTimezone"} + } + }, + "UpdateGatewayInformationOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway that was updated.

" + }, + "UpdateGatewaySoftwareNowInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway to update.

" + }, + "UpdateGatewaySoftwareNowOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway that was updated.

" + }, + "UpdateMaintenanceStartTimeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "HourOfDay", + "MinuteOfHour", + "DayOfWeek" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "HourOfDay":{ + "shape":"HourOfDay", + "documentation":"

The hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.

" + }, + "MinuteOfHour":{ + "shape":"MinuteOfHour", + "documentation":"

The minute component of the maintenance start time represented as mm, where mm is the minute\n (00 to 59). The minute of the hour is in the time zone of the gateway.

" + }, + "DayOfWeek":{ + "shape":"DayOfWeek", + "documentation":"

The maintenance start time day of the week.

" + } + }, + "documentation":"

A JSON object containing the following fields:

\n " + }, + "UpdateMaintenanceStartTimeOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

A JSON object containing the of the gateway whose maintenance start time is updated.

" + }, + "UpdateSnapshotScheduleInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "StartAt", + "RecurrenceInHours" + ], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway\n volumes.

" + }, + "StartAt":{ + "shape":"HourOfDay", + "documentation":"

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour\n (0 to 23). The hour of the day is in the time zone of the gateway.

" + }, + "RecurrenceInHours":{ + "shape":"RecurrenceInHours", + "documentation":"

Frequency of snapshots. Specify the number of hours between snapshots.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Optional description of the snapshot that overwrites the existing description.

" + } + }, + "documentation":"

A JSON object containing one or more of the following fields:

\n " + }, + "UpdateSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + }, + "documentation":"

A JSON object containing the of the updated storage volume.

" + }, + "VTLDevice":{ + "type":"structure", + "members":{ + "VTLDeviceARN":{ + "shape":"VTLDeviceARN", + "documentation":"

Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).

" + }, + "VTLDeviceType":{"shape":"VTLDeviceType"}, + "VTLDeviceVendor":{"shape":"VTLDeviceVendor"}, + "VTLDeviceProductIdentifier":{"shape":"VTLDeviceProductIdentifier"}, + "DeviceiSCSIAttributes":{ + "shape":"DeviceiSCSIAttributes", + "documentation":"

A list of iSCSI information about a VTL device.

" + } + }, + "documentation":"

Represents a device object associated with a gateway-VTL.

" + }, + "VTLDeviceARN":{ + "type":"string", + "min":50, + "max":500 + }, + "VTLDeviceARNs":{ + "type":"list", + "member":{"shape":"VTLDeviceARN"} + }, + "VTLDeviceProductIdentifier":{"type":"string"}, + "VTLDeviceType":{"type":"string"}, + "VTLDeviceVendor":{"type":"string"}, + "VTLDevices":{ + "type":"list", + "member":{"shape":"VTLDevice"} + }, + "VolumeARN":{ + "type":"string", + "min":50, + "max":500 + }, + "VolumeARNs":{ + "type":"list", + "member":{"shape":"VolumeARN"} + }, + "VolumeId":{ + "type":"string", + "min":12, + "max":30 + }, + "VolumeInfo":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeType":{"shape":"VolumeType"} + } + }, + "VolumeInfos":{ + "type":"list", + "member":{"shape":"VolumeInfo"} + }, + "VolumeRecoveryPointInfo":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeSizeInBytes":{"shape":"long"}, + "VolumeUsageInBytes":{"shape":"long"}, + "VolumeRecoveryPointTime":{"shape":"string"} + } + }, + "VolumeRecoveryPointInfos":{ + "type":"list", + "member":{"shape":"VolumeRecoveryPointInfo"} + }, + "VolumeStatus":{ + "type":"string", + "min":3, + "max":50 + }, + "VolumeType":{ + "type":"string", + "min":3, + "max":100 + }, + "VolumeiSCSIAttributes":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

The Amazon Resource Name (ARN) of the volume target.

" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The network interface identifier.

" + }, + "NetworkInterfacePort":{ + "shape":"integer", + "documentation":"

The port used to communicate with iSCSI targets.

" + }, + "LunNumber":{ + "shape":"PositiveIntObject", + "documentation":"

The logical disk number.

" + }, + "ChapEnabled":{ + "shape":"boolean", + "documentation":"

Indicates whether mutual CHAP is enabled for the iSCSI target.

" + } + }, + "documentation":"

Lists iSCSI information about a volume.

" + }, + "boolean":{"type":"boolean"}, + "double":{"type":"double"}, + "errorDetails":{ + "type":"map", + "key":{"shape":"string"}, + "value":{"shape":"string"} + }, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"} + } +} diff --git a/apis/storagegateway-2013-06-30.paginators.json b/apis/storagegateway-2013-06-30.paginators.json new file mode 100644 index 0000000000..286915c636 --- /dev/null +++ b/apis/storagegateway-2013-06-30.paginators.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "DescribeCachediSCSIVolumes": { + "result_key": "CachediSCSIVolumes" + }, + "DescribeStorediSCSIVolumes": { + "result_key": "StorediSCSIVolumes" + }, + "DescribeTapeArchives": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeArchives" + }, + "DescribeTapeRecoveryPoints": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeRecoveryPointInfos" + }, + "DescribeTapes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Tapes" + }, + "DescribeVTLDevices": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "VTLDevices" + }, + "ListGateways": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Gateways" + }, + "ListLocalDisks": { + "result_key": "Disks" + }, + "ListVolumeRecoveryPoints": { + "result_key": "VolumeRecoveryPointInfos" + }, + "ListVolumes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "VolumeInfos" + } + } +} diff --git a/apis/sts-2011-06-15.api.json b/apis/sts-2011-06-15.api.json new file mode 100644 index 0000000000..8dab4ecfda --- /dev/null +++ b/apis/sts-2011-06-15.api.json @@ -0,0 +1,233 @@ +{ + "metadata": { + "apiVersion": "2011-06-15", + "endpointPrefix": "sts", + "globalEndpoint": "sts.amazonaws.com", + "serviceAbbreviation": "AWS STS", + "serviceFullName": "AWS Security Token Service", + "signatureVersion": "v4", + "xmlNamespace": "https://sts.amazonaws.com/doc/2011-06-15/", + "protocol": "query" + }, + "operations": { + "AssumeRole": { + "input": { + "type": "structure", + "required": [ + "RoleArn", + "RoleSessionName" + ], + "members": { + "RoleArn": {}, + "RoleSessionName": {}, + "Policy": {}, + "DurationSeconds": { + "type": "integer" + }, + "ExternalId": {}, + "SerialNumber": {}, + "TokenCode": {} + } + }, + "output": { + "resultWrapper": "AssumeRoleResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + }, + "AssumedRoleUser": { + "shape": "Sf" + }, + "PackedPolicySize": { + "type": "integer" + } + } + } + }, + "AssumeRoleWithSAML": { + "input": { + "type": "structure", + "required": [ + "RoleArn", + "PrincipalArn", + "SAMLAssertion" + ], + "members": { + "RoleArn": {}, + "PrincipalArn": {}, + "SAMLAssertion": {}, + "Policy": {}, + "DurationSeconds": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "AssumeRoleWithSAMLResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + }, + "AssumedRoleUser": { + "shape": "Sf" + }, + "PackedPolicySize": { + "type": "integer" + }, + "Subject": {}, + "SubjectType": {}, + "Issuer": {}, + "Audience": {}, + "NameQualifier": {} + } + } + }, + "AssumeRoleWithWebIdentity": { + "input": { + "type": "structure", + "required": [ + "RoleArn", + "RoleSessionName", + "WebIdentityToken" + ], + "members": { + "RoleArn": {}, + "RoleSessionName": {}, + "WebIdentityToken": {}, + "ProviderId": {}, + "Policy": {}, + "DurationSeconds": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "AssumeRoleWithWebIdentityResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + }, + "SubjectFromWebIdentityToken": {}, + "AssumedRoleUser": { + "shape": "Sf" + }, + "PackedPolicySize": { + "type": "integer" + }, + "Provider": {}, + "Audience": {} + } + } + }, + "DecodeAuthorizationMessage": { + "input": { + "type": "structure", + "required": [ + "EncodedMessage" + ], + "members": { + "EncodedMessage": {} + } + }, + "output": { + "resultWrapper": "DecodeAuthorizationMessageResult", + "type": "structure", + "members": { + "DecodedMessage": {} + } + } + }, + "GetFederationToken": { + "input": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {}, + "Policy": {}, + "DurationSeconds": { + "type": "integer" + } + } + }, + "output": { + "resultWrapper": "GetFederationTokenResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + }, + "FederatedUser": { + "type": "structure", + "required": [ + "FederatedUserId", + "Arn" + ], + "members": { + "FederatedUserId": {}, + "Arn": {} + } + }, + "PackedPolicySize": { + "type": "integer" + } + } + } + }, + "GetSessionToken": { + "input": { + "type": "structure", + "members": { + "DurationSeconds": { + "type": "integer" + }, + "SerialNumber": {}, + "TokenCode": {} + } + }, + "output": { + "resultWrapper": "GetSessionTokenResult", + "type": "structure", + "members": { + "Credentials": { + "shape": "Sa" + } + } + } + } + }, + "shapes": { + "Sa": { + "type": "structure", + "required": [ + "AccessKeyId", + "SecretAccessKey", + "SessionToken", + "Expiration" + ], + "members": { + "AccessKeyId": {}, + "SecretAccessKey": {}, + "SessionToken": {}, + "Expiration": { + "type": "timestamp" + } + } + }, + "Sf": { + "type": "structure", + "required": [ + "AssumedRoleId", + "Arn" + ], + "members": { + "AssumedRoleId": {}, + "Arn": {} + } + } + } +} \ No newline at end of file diff --git a/apis/sts-2011-06-15.full.json b/apis/sts-2011-06-15.full.json new file mode 100644 index 0000000000..a23d903d39 --- /dev/null +++ b/apis/sts-2011-06-15.full.json @@ -0,0 +1,786 @@ +{ + "metadata":{ + "apiVersion":"2011-06-15", + "endpointPrefix":"sts", + "globalEndpoint":"sts.amazonaws.com", + "serviceAbbreviation":"AWS STS", + "serviceFullName":"AWS Security Token Service", + "signatureVersion":"v4", + "xmlNamespace":"https://sts.amazonaws.com/doc/2011-06-15/", + "protocol":"query" + }, + "documentation":"AWS Security Token Service\n\n

The AWS Security Token Service (STS) is a web service that enables you to request temporary,\n limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate\n (federated users). This guide provides descriptions of the STS API. For more detailed\n information about using this service, go to Using\n Temporary Security Credentials.

\n\n As an alternative to using the API, you can use one of the AWS SDKs, which consist of\n libraries and sample code for various programming languages and platforms (Java, Ruby, .NET,\n iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to\n STS. For example, the SDKs take care of cryptographically signing requests, managing\n errors, and retrying requests automatically. For information about the AWS SDKs, including how\n to download and install them, see the Tools for Amazon\n Web Services page. \n\n

For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For\n general information about the Query API, go to Making Query Requests in Using IAM. For information about using\n security tokens with other AWS products, go to Using Temporary\n Security Credentials to Access AWS in Using Temporary Security Credentials.

\n\n

If you're new to AWS and need additional technical information about a specific AWS product,\n you can find the product's technical documentation at http://aws.amazon.com/documentation/.

\n\n

\n Endpoints\n

\n

For information about STS endpoints, see Regions and Endpoints in the AWS General Reference.

\n\n

\n Recording API requests\n

\n

STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS\n account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine what requests were successfully made to STS, who made the\n request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the AWS\n CloudTrail User Guide.

", + "operations":{ + "AssumeRole":{ + "name":"AssumeRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssumeRoleRequest"}, + "output":{ + "shape":"AssumeRoleResponse", + "documentation":"

Contains the result of a successful call to the AssumeRole action, including\n temporary AWS credentials that can be used to make AWS requests.

", + "resultWrapper":"AssumeRoleResult" + }, + "errors":[ + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

" + }, + { + "shape":"PackedPolicyTooLargeException", + "error":{ + "code":"PackedPolicyTooLarge", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was too large. The error message\n describes how big the policy document is, in packed form, as a percentage of what the API\n allows.

" + } + ], + "documentation":"

Returns a set of temporary security credentials (consisting of an access key ID, a secret\n access key, and a security token) that you can use to access AWS resources that you might not\n normally have access to. Typically, you use AssumeRole for cross-account access\n or federation.

\n\n

Important: You cannot call AssumeRole by using AWS account credentials;\n access will be denied. You must use IAM user credentials or temporary security credentials\n to call AssumeRole.

\n\n

For cross-account access, imagine that you own multiple accounts and need to access resources\n in each account. You could create long-term credentials in each account to access those\n resources. However, managing all those credentials and remembering which one can access which\n account can be time consuming. Instead, you can create one set of long-term credentials in one\n account and then use temporary security credentials to access all the other accounts by\n assuming roles in those accounts. For more information about roles, see Roles in\n Using IAM.

\n\n

For federation, you can, for example, grant single sign-on access to the AWS Management\n Console. If you already have an identity and authentication system in your corporate network,\n you don't have to recreate user identities in AWS in order to grant those user identities\n access to AWS. Instead, after a user has been authenticated, you call AssumeRole\n (and specify the role with the appropriate permissions) to get temporary security credentials\n for that user. With those temporary security credentials, you construct a sign-in URL that\n users can use to access the console. For more information, see Scenarios for\n Granting Temporary Access in Using Temporary Security Credentials.

\n\n

The temporary security credentials are valid for the duration that you specified when calling\n AssumeRole, which can be from 900 seconds (15 minutes) to 3600 seconds (1\n hour). The default is 1 hour.

\n\n\n

Optionally, you can pass an IAM access policy to this operation. If you choose not to pass\n a policy, the temporary security credentials that are returned by the operation have the\n permissions that are defined in the access policy of the role that is being assumed. If you\n pass a policy to this operation, the temporary security credentials that are returned by the\n operation have the permissions that are allowed by both the access policy of the role that is\n being assumed, and the policy that you pass. This gives you a way to further\n restrict the permissions for the resulting temporary security credentials. You cannot use the\n passed policy to grant permissions that are in excess of those allowed by the access policy of\n the role that is being assumed. For more information, see Permissions for\n AssumeRole in Using Temporary Security Credentials.

\n\n

To assume a role, your AWS account must be trusted by the role. The trust relationship is\n defined in the role's trust policy when the role is created. You must also have a policy that\n allows you to call sts:AssumeRole.

\n\n

\n Using MFA with AssumeRole\n

\n

You can optionally include multi-factor authentication (MFA) information when you call\n AssumeRole. This is useful for cross-account scenarios in which you want to\n make sure that the user who is assuming the role has been authenticated using an AWS MFA\n device. In that scenario, the trust policy of the role being assumed includes a condition that\n tests for MFA authentication; if the caller does not include valid MFA information, the\n request to assume the role is denied. The condition in a trust policy that tests for MFA\n authentication might look like the following example.

\n\n

\n \"Condition\": {\"Null\": {\"aws:MultiFactorAuthAge\": false}}\n

\n\n

For more information, see Configuring\n MFA-Protected API Access in the Using IAM guide.

\n\n

To use MFA with AssumeRole, you pass values for the SerialNumber\n and TokenCode parameters. The SerialNumber value identifies the\n user's hardware or virtual MFA device. The TokenCode is the time-based one-time\n password (TOTP) that the MFA devices produces.

\n\n\n \n \n \n \n \n \n https://sts.amazonaws.com/\n?Version=2011-06-15\n&Action=AssumeRole\n&RoleSessionName=Bob\n&RoleArn=arn:aws:iam::123456789012:role/demo\n&Policy=%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Sid%22%3A%22Stmt1%22%2C%22Effect%22%\n 3A%22Allow%22%2C%22Action%22%3A%22s3%3A*%22%2C%22Resource%22%3A%22*%22%7D\n %5D%7D\n&DurationSeconds=3600\n&ExternalId=123ABC\n&AUTHPARAMS\n\n \n \n \n \n AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQW\n LWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGd\n QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU\n 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz\n +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==\n \n \n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n 2011-07-15T23:28:33.359Z\n AKIAIOSFODNN7EXAMPLE\n \n \n arn:aws:sts::123456789012:assumed-role/demo/Bob\n ARO123EXAMPLE123:Bob\n \n 6\n \n \n c6104cbe-af31-11e0-8154-cbc7ccf896c7\n \n\n\n " + }, + "AssumeRoleWithSAML":{ + "name":"AssumeRoleWithSAML", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssumeRoleWithSAMLRequest"}, + "output":{ + "shape":"AssumeRoleWithSAMLResponse", + "documentation":"

Contains the result of a successful call to the AssumeRoleWithSAML action, including\n temporary AWS credentials that can be used to make AWS requests.

", + "resultWrapper":"AssumeRoleWithSAMLResult" + }, + "errors":[ + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

" + }, + { + "shape":"PackedPolicyTooLargeException", + "error":{ + "code":"PackedPolicyTooLarge", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was too large. The error message\n describes how big the policy document is, in packed form, as a percentage of what the API\n allows.

" + }, + { + "shape":"IDPRejectedClaimException", + "error":{ + "code":"IDPRejectedClaim", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The identity provider (IdP) reported that authentication failed. This might be because the\n claim is invalid.

\n

If this error is returned for the AssumeRoleWithWebIdentity operation, it can\n also mean that the claim has expired or has been explicitly revoked.

" + }, + { + "shape":"InvalidIdentityTokenException", + "error":{ + "code":"InvalidIdentityToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The web identity token that was passed could not be validated by AWS. Get a new identity\n token from the identity provider and then retry the request.

" + }, + { + "shape":"ExpiredTokenException", + "error":{ + "code":"ExpiredTokenException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The web identity token that was passed is expired or is not valid. Get a new identity token\n from the identity provider and then retry the request.

" + } + ], + "documentation":"

Returns a set of temporary security credentials for users who have been authenticated via a\n SAML authentication response. This operation provides a mechanism for tying an enterprise\n identity store or directory to role-based AWS access without user-specific credentials or\n configuration.

\n\n

The temporary security credentials returned by this operation consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to AWS services. The credentials are valid for the duration that you\n specified when calling AssumeRoleWithSAML, which can be up to 3600 seconds (1\n hour) or until the time specified in the SAML authentication response's\n NotOnOrAfter value, whichever is shorter.

\n\n The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even\n if values outside this range are specified. \n\n

Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a\n policy, the temporary security credentials that are returned by the operation have the\n permissions that are defined in the access policy of the role that is being assumed. If you\n pass a policy to this operation, the temporary security credentials that are returned by the\n operation have the permissions that are allowed by both the access policy of the role that is\n being assumed, and the policy that you pass. This gives you a way to further\n restrict the permissions for the resulting temporary security credentials. You cannot use the\n passed policy to grant permissions that are in excess of those allowed by the access policy of\n the role that is being assumed. For more information, see Permissions for\n AssumeRoleWithSAML in Using Temporary Security Credentials.

\n\n

Before your application can call AssumeRoleWithSAML, you must configure your\n SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use\n AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your\n identity provider, and create an IAM role that specifies this SAML provider in its trust\n policy.

\n\n

Calling AssumeRoleWithSAML does not require the use of AWS security\n credentials. The identity of the caller is validated by using keys in the metadata document\n that is uploaded for the SAML provider entity for your identity provider.

\n\n

For more information, see the following resources:

\n\n \n\n \n \n \n " + }, + "AssumeRoleWithWebIdentity":{ + "name":"AssumeRoleWithWebIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssumeRoleWithWebIdentityRequest"}, + "output":{ + "shape":"AssumeRoleWithWebIdentityResponse", + "documentation":"

Contains the result of a successful call to the AssumeRoleWithWebIdentity action,\n including temporary AWS credentials that can be used to make AWS requests.

", + "resultWrapper":"AssumeRoleWithWebIdentityResult" + }, + "errors":[ + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

" + }, + { + "shape":"PackedPolicyTooLargeException", + "error":{ + "code":"PackedPolicyTooLarge", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was too large. The error message\n describes how big the policy document is, in packed form, as a percentage of what the API\n allows.

" + }, + { + "shape":"IDPRejectedClaimException", + "error":{ + "code":"IDPRejectedClaim", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The identity provider (IdP) reported that authentication failed. This might be because the\n claim is invalid.

\n

If this error is returned for the AssumeRoleWithWebIdentity operation, it can\n also mean that the claim has expired or has been explicitly revoked.

" + }, + { + "shape":"IDPCommunicationErrorException", + "error":{ + "code":"IDPCommunicationError", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked\n to verify the incoming identity token could not be reached. This is often a transient error\n caused by network conditions. Retry the request a limited number of times so that you don't\n exceed the request rate. If the error persists, the non-AWS identity provider might be down or\n not responding.

" + }, + { + "shape":"InvalidIdentityTokenException", + "error":{ + "code":"InvalidIdentityToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The web identity token that was passed could not be validated by AWS. Get a new identity\n token from the identity provider and then retry the request.

" + }, + { + "shape":"ExpiredTokenException", + "error":{ + "code":"ExpiredTokenException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The web identity token that was passed is expired or is not valid. Get a new identity token\n from the identity provider and then retry the request.

" + } + ], + "documentation":"

Returns a set of temporary security credentials for users who have been authenticated in a\n mobile or web application with a web identity provider, such as Login with Amazon, Facebook,\n or Google.

\n\n

Calling AssumeRoleWithWebIdentity does not require the use of AWS security\n credentials. Therefore, you can distribute an application (for example, on mobile devices)\n that requests temporary security credentials without including long-term AWS credentials in\n the application, and without deploying server-based proxy services that use long-term AWS\n credentials. Instead, the identity of the caller is validated by using a token from the web\n identity provider.

\n\n

The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to AWS service APIs. The credentials are valid for the duration that\n you specified when calling AssumeRoleWithWebIdentity, which can be from 900\n seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials\n are valid for 1 hour.

\n\n

Optionally, you can pass an IAM access policy to this operation. If you choose not to pass\n a policy, the temporary security credentials that are returned by the operation have the\n permissions that are defined in the access policy of the role that is being assumed. If you\n pass a policy to this operation, the temporary security credentials that are returned by the\n operation have the permissions that are allowed by both the access policy of the role that is\n being assumed, and the policy that you pass. This gives you a way to further\n restrict the permissions for the resulting temporary security credentials. You cannot use the\n passed policy to grant permissions that are in excess of those allowed by the access policy of\n the role that is being assumed. For more information, see Permissions for\n AssumeRoleWithWebIdentity in Using Temporary Security Credentials.

\n\n

Before your application can call AssumeRoleWithWebIdentity, you must have an\n identity token from a supported identity provider and create a role that the application can\n assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified in\n the role's trust policy.

\n\n

For more information about how to use web identity federation and the\n AssumeRoleWithWebIdentity, see the following resources:

\n\n \n\n \n \n \n \n \n \n\n \n\n https://sts.amazonaws.com/\n?Action=AssumeRoleWithWebIdentity\n&DurationSeconds=3600\n&ProviderId=www.amazon.com\n&RoleSessionName=app1\n&Version=2011-06-15\n&RoleArn=arn%3Aaws%3Aiam%3A%3A000240903217%3Arole%2FFederatedWebIdentityRole\n&WebIdentityToken=Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXX\nXXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFB\nmtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNI\nL016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAG\npsp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ\n \n\n \n \n \n amzn1.account.AF6RHO7KZU5XRVQJGXK6HB56KR2A\n \n \n \n arn:aws:sts::000240903217:assumed-role/FederatedWebIdentityRole/app1\n \n \n AROACLKWSDQRAOFQC3IDI:app1\n \n \n \n \n AQoDYXdzEE0a8ANXXXXXXXXNO1ewxE5TijQyp+IPfnyowF\n \n \n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n \n 2013-05-14T23:00:23Z\n \n \n AKIAIOSFODNN7EXAMPLE\n \n \n apps.example.com\n \n \n client.5498841531868486423.1548@apps.example.com\n \n \n \n \n ad4156e9-bce1-11e2-82e6-6b6ef249e618\n \n\n \n " + }, + "DecodeAuthorizationMessage":{ + "name":"DecodeAuthorizationMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DecodeAuthorizationMessageRequest"}, + "output":{ + "shape":"DecodeAuthorizationMessageResponse", + "documentation":"

A document that contains additional information about the authorization status of a request\n from an encoded message that is returned in response to an AWS request.

", + "resultWrapper":"DecodeAuthorizationMessageResult" + }, + "errors":[ + { + "shape":"InvalidAuthorizationMessageException", + "error":{ + "code":"InvalidAuthorizationMessageException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The error returned if the message passed to DecodeAuthorizationMessage was\n invalid. This can happen if the token contains invalid characters, such as linebreaks.

" + } + ], + "documentation":"

Decodes additional information about the authorization status of a request from an encoded\n message returned in response to an AWS request.

\n\n

For example, if a user is not authorized to perform an action that he or she has requested,\n the request returns a Client.UnauthorizedOperation response (an HTTP 403\n response). Some AWS actions additionally return an encoded message that can provide details\n about this authorization failure.

\n\n Only certain AWS actions return an encoded authorization message. The documentation for\n an individual action indicates whether that action returns an encoded message in addition to\n returning an HTTP code. \n\n

The message is encoded because the details of the authorization status can constitute\n privileged information that the user who requested the action should not see. To decode an\n authorization status message, a user must be granted permissions via an IAM policy to\n request the DecodeAuthorizationMessage\n (sts:DecodeAuthorizationMessage) action.

\n\n

The decoded message includes the following type of information:

\n\n \n\n \n POST https://sts.amazonaws.com / HTTP/1.1\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\nHost: sts.amazonaws.com\nContent-Length: 1148\nExpect: 100-continue\nConnection: Keep-Alive\nAction=DecodeAuthorizationMessage\n&EncodedMessage=\n&Version=2011-06-15\n&AUTHPARAMS\n\n \n \n 6624a9ca-cd25-4f50-b2a5-7ba65bf07453\n \n {\n \"allowed\": \"false\",\n \"explicitDeny\": \"false\",\n \"matchedStatements\": \"\",\n \"failures\": \"\",\n \"context\": {\n \"principal\": {\n \"id\": \"AIDACKCEVSQ6C2EXAMPLE\",\n \"name\": \"Bob\",\n \"arn\": \"arn:aws:iam::123456789012:user/Bob\"\n },\n \"action\": \"ec2:StopInstances\",\n \"resource\": \"arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd\",\n \"conditions\": [\n {\n \"item\": {\n \"key\": \"ec2:Tenancy\",\n \"values\": [\"default\"]\n },\n {\n \"item\": {\n \"key\": \"ec2:ResourceTag/elasticbeanstalk:environment-name\",\n \"values\": [\"Default-Environment\"]\n }\n },\n (Additional items ...)\n ]\n }\n }\n \n\n " + }, + "GetFederationToken":{ + "name":"GetFederationToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFederationTokenRequest"}, + "output":{ + "shape":"GetFederationTokenResponse", + "documentation":"

Contains the result of a successful call to the GetFederationToken action, including\n temporary AWS credentials that can be used to make AWS requests.

", + "resultWrapper":"GetFederationTokenResult" + }, + "errors":[ + { + "shape":"MalformedPolicyDocumentException", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

" + }, + { + "shape":"PackedPolicyTooLargeException", + "error":{ + "code":"PackedPolicyTooLarge", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was too large. The error message\n describes how big the policy document is, in packed form, as a percentage of what the API\n allows.

" + } + ], + "documentation":"

Returns a set of temporary security credentials (consisting of an access key ID, a secret\n access key, and a security token) for a federated user. A typical use is in a proxy\n application that gets temporary security credentials on behalf of distributed applications\n inside a corporate network. Because you must call the GetFederationToken action\n using the long-term security credentials of an IAM user, this call is appropriate in\n contexts where those credentials can be safely stored, usually in a server-based\n application.

\n\n

\n Note: Do not use this call in mobile applications or client-based web applications that\n directly get temporary security credentials. For those types of applications, use\n AssumeRoleWithWebIdentity.

\n\n

The GetFederationToken action must be called by using the long-term AWS security\n credentials of an IAM user. You can also call GetFederationToken using the\n security credentials of an AWS account (root), but this is not recommended. Instead, we\n recommend that you create an IAM user for the purpose of the proxy application and then\n attach a policy to the IAM user that limits federated users to only the actions and\n resources they need access to. For more information, see IAM Best Practices in\n Using IAM.

\n\n

The temporary security credentials that are obtained by using the long-term credentials of an\n IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600\n seconds (36 hours). Temporary credentials that are obtained by using AWS account (root)\n credentials have a maximum duration of 3600 seconds (1 hour)

\n\n

\n Permissions\n

\n \n

The permissions for the temporary security credentials returned by\n GetFederationToken are determined by a combination of the following:

\n \n \n

The passed policy is attached to the temporary security credentials that result from the\n GetFederationToken API call--that is, to the federated user. When the\n federated user makes an AWS request, AWS evaluates the policy attached to the federated user\n in combination with the policy or policies attached to the IAM user whose credentials were\n used to call GetFederationToken. AWS allows the federated user's request only\n when both the federated user and the IAM user are explicitly allowed to\n perform the requested action. The passed policy cannot grant more permissions than those that\n are defined in the IAM user policy.

\n\n

A typical use case is that the permissions of the IAM user whose credentials are used to\n call GetFederationToken are designed to allow access to all the actions and\n resources that any federated user will need. Then, for individual users, you pass a policy to\n the operation that scopes down the permissions to a level that's appropriate to that\n individual user, using a policy that allows only a subset of permissions that are granted to\n the IAM user.

\n\n

If you do not pass a policy, the resulting temporary security credentials have no effective\n permissions. The only exception is when the temporary security credentials are used to access\n a resource that has a resource-based policy that specifically allows the federated user to\n access the resource.

\n\n

For more information about how permissions work, see Permissions for GetFederationToken in Using Temporary Security Credentials. For information\n about using GetFederationToken to create temporary security credentials, see Creating Temporary Credentials\n to Enable Access for Federated Users in Using Temporary Security Credentials.

\n \n https://sts.amazonaws.com/\n?Version=2011-06-15\n&Action=GetFederationToken\n&Name=Bob\n&Policy=%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Sid%22%3A%22Stmt1%22%2C%22Effect%22%\n 3A%22Allow%22%2C%22Action%22%3A%22s3%3A*%22%2C%22Resource%22%3A%22*%22%7D\n %5D%7D\n&DurationSeconds=3600\n&AUTHPARAMS\n \n\n \n \n \n \n AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQW\n LWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGd\n QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU\n 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz\n +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==\n \n \n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n 2011-07-15T23:28:33.359Z\n AKIAIOSFODNN7EXAMPLE\n \n \n arn:aws:sts::123456789012:federated-user/Bob\n 123456789012:Bob\n \n 6\n \n \n c6104cbe-af31-11e0-8154-cbc7ccf896c7\n \n\n \n\n " + }, + "GetSessionToken":{ + "name":"GetSessionToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSessionTokenRequest"}, + "output":{ + "shape":"GetSessionTokenResponse", + "documentation":"

Contains the result of a successful call to the GetSessionToken action, including\n temporary AWS credentials that can be used to make AWS requests.

", + "resultWrapper":"GetSessionTokenResult" + }, + "documentation":"

Returns a set of temporary credentials for an AWS account or IAM user. The credentials\n consist of an access key ID, a secret access key, and a security token. Typically, you use\n GetSessionToken if you want to use MFA to protect programmatic calls to\n specific AWS APIs like Amazon EC2 StopInstances. MFA-enabled IAM users would\n need to call GetSessionToken and submit an MFA code that is associated with their\n MFA device. Using the temporary security credentials that are returned from the call, IAM\n users can then make programmatic calls to APIs that require MFA authentication.

\n\n

The GetSessionToken action must be called by using the long-term AWS security\n credentials of the AWS account or an IAM user. Credentials that are created by IAM users\n are valid for the duration that you specify, between 900 seconds (15 minutes) and 129600\n seconds (36 hours); credentials that are created by using account credentials have a maximum\n duration of 3600 seconds (1 hour).

\n \n \n

We recommend that you do not call GetSessionToken with root account credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.

\n \n \n

The permissions associated with the temporary security credentials returned by\n GetSessionToken are based on the permissions associated with account or IAM\n user whose credentials are used to call the action. If GetSessionToken is called\n using root account credentials, the temporary credentials have root account permissions.\n Similarly, if GetSessionToken is called using the credentials of an IAM user,\n the temporary credentials have the same permissions as the IAM user.

\n\n

For more information about using GetSessionToken to create temporary\n credentials, go to Creating Temporary Credentials to Enable Access for IAM Users in\n Using Temporary Security Credentials.

\n\n \n https://sts.amazonaws.com/\n?Version=2011-06-15\n&Action=GetSessionToken\n&DurationSeconds=3600\n&SerialNumber=YourMFADeviceSerialNumber\n&TokenCode=123456\n&AUTHPARAMS\n \n\n \n \n \n \n AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/L\n To6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3z\n rkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtp\n Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE\n \n \n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n 2011-07-11T19:55:29.611Z\n AKIAIOSFODNN7EXAMPLE\n \n \n \n 58c5dbae-abef-11e0-8cfe-09039844ac7d\n \n\n \n " + } + }, + "shapes":{ + "AssumeRoleRequest":{ + "type":"structure", + "required":[ + "RoleArn", + "RoleSessionName" + ], + "members":{ + "RoleArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the role that the caller is assuming.

" + }, + "RoleSessionName":{ + "shape":"userNameType", + "documentation":"

An identifier for the assumed role session. The session name is included as part of the\n AssumedRoleUser.

" + }, + "Policy":{ + "shape":"sessionPolicyDocumentType", + "documentation":"

An IAM policy in JSON format.

\n\n

The policy parameter is optional. If you pass a policy, the temporary security credentials\n that are returned by the operation have the permissions that are allowed by both the access\n policy of the role that is being assumed, and the policy that you pass. This\n gives you a way to further restrict the permissions for the resulting temporary security\n credentials. You cannot use the passed policy to grant permissions that are in excess of those\n allowed by the access policy of the role that is being assumed. For more information, see Permissions for\n AssumeRole in Using Temporary Security Credentials.

" + }, + "DurationSeconds":{ + "shape":"roleDurationSecondsType", + "documentation":"

The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

" + }, + "ExternalId":{ + "shape":"externalIdType", + "documentation":"

A unique identifier that is used by third parties to assume a role in their customers'\n accounts. For each role that the third party can assume, they should instruct their customers\n to create a role with the external ID that the third party generated. Each time the third\n party assumes the role, they must pass the customer's external ID. The external ID is useful\n in order to help third parties bind a role to the customer who created it. For more\n information about the external ID, see About the External ID in Using Temporary Security Credentials.

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The identification number of the MFA device that is associated with the user who is making\n the AssumeRole call. Specify this value if the trust policy of the role being\n assumed includes a condition that requires MFA authentication. The value is either the serial\n number for a hardware device (such as GAHT12345678) or an Amazon Resource Name\n (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).

" + }, + "TokenCode":{ + "shape":"tokenCodeType", + "documentation":"

The value provided by the MFA device, if the trust policy of the role being assumed requires\n MFA (that is, if the policy includes a condition that tests for MFA). If the role being\n assumed requires MFA and if the TokenCode value is missing or expired, the\n AssumeRole call returns an \"access denied\" error.

" + } + } + }, + "AssumeRoleResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

The temporary security credentials, which include an access key ID, a secret access key, and\n a security (or session) token.

" + }, + "AssumedRoleUser":{ + "shape":"AssumedRoleUser", + "documentation":"

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can\n use to refer to the resulting temporary security credentials. For example, you can reference\n these credentials as a principal in a resource-based policy by using the ARN or assumed role\n ID. The ARN and ID include the RoleSessionName that you specified when you called\n AssumeRole.

" + }, + "PackedPolicySize":{ + "shape":"nonNegativeIntegerType", + "documentation":"

A percentage value that indicates the size of the policy in packed form. The service rejects\n any policy with a packed size greater than 100 percent, which means the policy exceeded the\n allowed space.

" + } + }, + "documentation":"

Contains the result of a successful call to the AssumeRole action, including\n temporary AWS credentials that can be used to make AWS requests.

" + }, + "AssumeRoleWithSAMLRequest":{ + "type":"structure", + "required":[ + "RoleArn", + "PrincipalArn", + "SAMLAssertion" + ], + "members":{ + "RoleArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the role that the caller is assuming.

" + }, + "PrincipalArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

" + }, + "SAMLAssertion":{ + "shape":"SAMLAssertionType", + "documentation":"

The base-64 encoded SAML authentication response provided by the IdP.

\n

For more information, see Configuring\n a Relying Party and Adding Claims in the Using IAM guide.

" + }, + "Policy":{ + "shape":"sessionPolicyDocumentType", + "documentation":"

An IAM policy in JSON format.

\n\n

The policy parameter is optional. If you pass a policy, the temporary security credentials\n that are returned by the operation have the permissions that are allowed by both the access\n policy of the role that is being assumed, and the policy that you pass. This\n gives you a way to further restrict the permissions for the resulting temporary security\n credentials. You cannot use the passed policy to grant permissions that are in excess of those\n allowed by the access policy of the role that is being assumed. For more information, see Permissions for\n AssumeRoleWithSAML in Using Temporary Security Credentials.

\n\n The policy must be 2048 bytes or shorter, and its packed size must be less than 450\n bytes." + }, + "DurationSeconds":{ + "shape":"durationSecondsType", + "documentation":"

The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration\n can also be specified in the SAML authentication response's NotOnOrAfter value.\n The actual expiration time is whichever value is shorter.

\n\n The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even\n if values outside this range are specified. " + } + } + }, + "AssumeRoleWithSAMLResponse":{ + "type":"structure", + "members":{ + "Credentials":{"shape":"Credentials"}, + "AssumedRoleUser":{"shape":"AssumedRoleUser"}, + "PackedPolicySize":{ + "shape":"nonNegativeIntegerType", + "documentation":"

A percentage value that indicates the size of the policy in packed form. The service rejects\n any policy with a packed size greater than 100 percent, which means the policy exceeded the\n allowed space.

" + }, + "Subject":{"shape":"Subject"}, + "SubjectType":{"shape":"SubjectType"}, + "Issuer":{"shape":"Issuer"}, + "Audience":{"shape":"Audience"}, + "NameQualifier":{"shape":"NameQualifier"} + }, + "documentation":"

Contains the result of a successful call to the AssumeRoleWithSAML action, including\n temporary AWS credentials that can be used to make AWS requests.

" + }, + "AssumeRoleWithWebIdentityRequest":{ + "type":"structure", + "required":[ + "RoleArn", + "RoleSessionName", + "WebIdentityToken" + ], + "members":{ + "RoleArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the role that the caller is assuming.

" + }, + "RoleSessionName":{ + "shape":"userNameType", + "documentation":"

An identifier for the assumed role session. Typically, you pass the name or identifier that\n is associated with the user who is using your application. That way, the temporary security\n credentials that your application will use are associated with that user. This session name is\n included as part of the ARN and assumed role ID in the AssumedRoleUser response\n element.

" + }, + "WebIdentityToken":{ + "shape":"clientTokenType", + "documentation":"

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity\n provider. Your application must get this token by authenticating the user who is using your\n application with a web identity provider before the application makes an\n AssumeRoleWithWebIdentity call.

" + }, + "ProviderId":{ + "shape":"urlType", + "documentation":"

The fully-qualified host component of the domain name of the identity provider. Specify this\n value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens,\n such as accounts.google.com. Do not include URL schemes and port numbers.\n Currently, www.amazon.com and graph.facebook.com are supported.

" + }, + "Policy":{ + "shape":"sessionPolicyDocumentType", + "documentation":"

An IAM policy in JSON format.

\n\n

The policy parameter is optional. If you pass a policy, the temporary security credentials\n that are returned by the operation have the permissions that are allowed by both the access\n policy of the role that is being assumed, and the policy that you pass. This\n gives you a way to further restrict the permissions for the resulting temporary security\n credentials. You cannot use the passed policy to grant permissions that are in excess of those\n allowed by the access policy of the role that is being assumed. For more information, see Permissions for\n AssumeRoleWithWebIdentity in Using Temporary Security Credentials.

" + }, + "DurationSeconds":{ + "shape":"durationSecondsType", + "documentation":"

The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

" + } + } + }, + "AssumeRoleWithWebIdentityResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

The temporary security credentials, which include an access key ID, a secret access key, and\n a security token.

" + }, + "SubjectFromWebIdentityToken":{ + "shape":"webIdentitySubjectType", + "documentation":"

The unique user identifier that is returned by the identity provider. This identifier is\n associated with the WebIdentityToken that was submitted with the\n AssumeRoleWithWebIdentity call. The identifier is typically unique to the user\n and the application that acquired the WebIdentityToken (pairwise identifier). If\n an OpenID Connect ID token was submitted in the WebIdentityToken, this value is\n returned by the identity provider as the token's sub (Subject) claim.

" + }, + "AssumedRoleUser":{ + "shape":"AssumedRoleUser", + "documentation":"

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can\n use to refer to the resulting temporary security credentials. For example, you can reference\n these credentials as a principal in a resource-based policy by using the ARN or assumed role\n ID. The ARN and ID include the RoleSessionName that you specified when you called\n AssumeRole.

" + }, + "PackedPolicySize":{ + "shape":"nonNegativeIntegerType", + "documentation":"

A percentage value that indicates the size of the policy in packed form. The service rejects\n any policy with a packed size greater than 100 percent, which means the policy exceeded the\n allowed space.

" + }, + "Provider":{ + "shape":"Issuer", + "documentation":"

The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains\n the value of the iss field. For OAuth 2.0 Access Tokens, this contains the value of the\n ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

" + }, + "Audience":{ + "shape":"Audience", + "documentation":"

The intended audience of the web identity token. This is traditionally the\n client identifier issued to the application that requested the web identity token.

" + } + }, + "documentation":"

Contains the result of a successful call to the AssumeRoleWithWebIdentity action,\n including temporary AWS credentials that can be used to make AWS requests.

" + }, + "AssumedRoleUser":{ + "type":"structure", + "required":[ + "AssumedRoleId", + "Arn" + ], + "members":{ + "AssumedRoleId":{ + "shape":"assumedRoleIdType", + "documentation":"

A unique identifier that contains the role ID and the role session name of the role that is\n being assumed. The role ID is generated by AWS when the role is created.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The ARN of the temporary security credentials that are returned from the AssumeRole\n action. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.

" + } + }, + "documentation":"

The identifiers for the temporary security credentials that the operation returns.

" + }, + "Audience":{"type":"string"}, + "Credentials":{ + "type":"structure", + "required":[ + "AccessKeyId", + "SecretAccessKey", + "SessionToken", + "Expiration" + ], + "members":{ + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The access key ID that identifies the temporary security credentials.

" + }, + "SecretAccessKey":{ + "shape":"accessKeySecretType", + "documentation":"

The secret access key that can be used to sign requests.

" + }, + "SessionToken":{ + "shape":"tokenType", + "documentation":"

The token that users must pass to the service API to use the temporary credentials.

" + }, + "Expiration":{ + "shape":"dateType", + "documentation":"

The date on which the current credentials expire.

" + } + }, + "documentation":"

AWS credentials for API authentication.

" + }, + "DecodeAuthorizationMessageRequest":{ + "type":"structure", + "required":["EncodedMessage"], + "members":{ + "EncodedMessage":{ + "shape":"encodedMessageType", + "documentation":"

The encoded message that was returned with the response.

" + } + } + }, + "DecodeAuthorizationMessageResponse":{ + "type":"structure", + "members":{ + "DecodedMessage":{ + "shape":"decodedMessageType", + "documentation":"

An XML document that contains the decoded message. For more information, see\n DecodeAuthorizationMessage.

" + } + }, + "documentation":"

A document that contains additional information about the authorization status of a request\n from an encoded message that is returned in response to an AWS request.

" + }, + "ExpiredTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"expiredIdentityTokenMessage"} + }, + "error":{ + "code":"ExpiredTokenException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The web identity token that was passed is expired or is not valid. Get a new identity token\n from the identity provider and then retry the request.

" + }, + "FederatedUser":{ + "type":"structure", + "required":[ + "FederatedUserId", + "Arn" + ], + "members":{ + "FederatedUserId":{ + "shape":"federatedIdType", + "documentation":"

The string that identifies the federated user associated with the credentials, similar to the\n unique ID of an IAM user.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The ARN that specifies the federated user that is associated with the credentials. For more\n information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.

" + } + }, + "documentation":"

Identifiers for the federated user that is associated with the credentials.

" + }, + "GetFederationTokenRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"userNameType", + "documentation":"

The name of the federated user. The name is used as an identifier for the temporary security\n credentials (such as Bob). For example, you can reference the federated user name\n in a resource-based policy, such as in an Amazon S3 bucket policy.

" + }, + "Policy":{ + "shape":"sessionPolicyDocumentType", + "documentation":"

An IAM policy in JSON format that is passed with the GetFederationToken call\n and evaluated along with the policy or policies that are attached to the IAM user whose\n credentials are used to call GetFederationToken. The passed policy is used to\n scope down the permissions that are available to the IAM user, by allowing only a subset of\n the permissions that are granted to the IAM user. The passed policy cannot grant more\n permissions than those granted to the IAM user. The final permissions for the federated user\n are the most restrictive set based on the intersection of the passed policy and the IAM user\n policy.

\n\n

If you do not pass a policy, the resulting temporary security credentials have no effective\n permissions. The only exception is when the temporary security credentials are used to access\n a resource that has a resource-based policy that specifically allows the federated user to\n access the resource.

\n

For more information about how permissions work, see Permissions for\n GetFederationToken in Using Temporary Security Credentials.

" + }, + "DurationSeconds":{ + "shape":"durationSecondsType", + "documentation":"

The duration, in seconds, that the session should last. Acceptable durations for federation\n sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds\n (12 hours) as the default. Sessions obtained using AWS account (root) credentials are\n restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than\n one hour, the session obtained by using AWS account (root) credentials defaults to one hour.\n

" + } + } + }, + "GetFederationTokenResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

Credentials for the service API authentication.

" + }, + "FederatedUser":{ + "shape":"FederatedUser", + "documentation":"

Identifiers for the federated user associated with the credentials (such as\n arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob).\n You can use the federated user's ARN in your resource-based policies, such as an Amazon S3\n bucket policy.

" + }, + "PackedPolicySize":{ + "shape":"nonNegativeIntegerType", + "documentation":"

A percentage value indicating the size of the policy in packed form. The service rejects\n policies for which the packed size is greater than 100 percent of the allowed value.

" + } + }, + "documentation":"

Contains the result of a successful call to the GetFederationToken action, including\n temporary AWS credentials that can be used to make AWS requests.

" + }, + "GetSessionTokenRequest":{ + "type":"structure", + "members":{ + "DurationSeconds":{ + "shape":"durationSecondsType", + "documentation":"

The duration, in seconds, that the credentials should remain valid. Acceptable durations for\n IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200\n seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum\n of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS\n account owners defaults to one hour.

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The identification number of the MFA device that is associated with the IAM user who is\n making the GetSessionToken call. Specify this value if the IAM user has a policy\n that requires MFA authentication. The value is either the serial number for a hardware device\n (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device\n (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM\n user by going to the AWS Management Console and viewing the user's security credentials.

" + }, + "TokenCode":{ + "shape":"tokenCodeType", + "documentation":"

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user\n to submit an MFA code, specify this value. If MFA authentication is required, and the user\n does not provide a code when requesting a set of temporary security credentials, the user will\n receive an \"access denied\" response when requesting resources that require MFA\n authentication.

" + } + } + }, + "GetSessionTokenResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

The session credentials for API authentication.

" + } + }, + "documentation":"

Contains the result of a successful call to the GetSessionToken action, including\n temporary AWS credentials that can be used to make AWS requests.

" + }, + "IDPCommunicationErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"idpCommunicationErrorMessage"} + }, + "error":{ + "code":"IDPCommunicationError", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked\n to verify the incoming identity token could not be reached. This is often a transient error\n caused by network conditions. Retry the request a limited number of times so that you don't\n exceed the request rate. If the error persists, the non-AWS identity provider might be down or\n not responding.

" + }, + "IDPRejectedClaimException":{ + "type":"structure", + "members":{ + "message":{"shape":"idpRejectedClaimMessage"} + }, + "error":{ + "code":"IDPRejectedClaim", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"

The identity provider (IdP) reported that authentication failed. This might be because the\n claim is invalid.

\n

If this error is returned for the AssumeRoleWithWebIdentity operation, it can\n also mean that the claim has expired or has been explicitly revoked.

" + }, + "InvalidAuthorizationMessageException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"invalidAuthorizationMessage", + "documentation":"

The error message associated with the error.

" + } + }, + "error":{ + "code":"InvalidAuthorizationMessageException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The error returned if the message passed to DecodeAuthorizationMessage was\n invalid. This can happen if the token contains invalid characters, such as linebreaks.

" + }, + "InvalidIdentityTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidIdentityTokenMessage"} + }, + "error":{ + "code":"InvalidIdentityToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The web identity token that was passed could not be validated by AWS. Get a new identity\n token from the identity provider and then retry the request.

" + }, + "Issuer":{"type":"string"}, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "message":{"shape":"malformedPolicyDocumentMessage"} + }, + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

" + }, + "NameQualifier":{"type":"string"}, + "PackedPolicyTooLargeException":{ + "type":"structure", + "members":{ + "message":{"shape":"packedPolicyTooLargeMessage"} + }, + "error":{ + "code":"PackedPolicyTooLarge", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because the policy document was too large. The error message\n describes how big the policy document is, in packed form, as a percentage of what the API\n allows.

" + }, + "SAMLAssertionType":{ + "type":"string", + "min":4, + "max":50000 + }, + "Subject":{"type":"string"}, + "SubjectType":{"type":"string"}, + "accessKeyIdType":{ + "type":"string", + "min":16, + "max":32, + "pattern":"[\\w]*" + }, + "accessKeySecretType":{"type":"string"}, + "arnType":{ + "type":"string", + "min":20, + "max":2048 + }, + "assumedRoleIdType":{ + "type":"string", + "min":2, + "max":96, + "pattern":"[\\w+=,.@:-]*" + }, + "clientTokenType":{ + "type":"string", + "min":4, + "max":2048 + }, + "dateType":{"type":"timestamp"}, + "decodedMessageType":{"type":"string"}, + "durationSecondsType":{ + "type":"integer", + "min":900, + "max":129600 + }, + "encodedMessageType":{ + "type":"string", + "min":1, + "max":10240 + }, + "expiredIdentityTokenMessage":{"type":"string"}, + "externalIdType":{ + "type":"string", + "min":2, + "max":96, + "pattern":"[\\w+=,.@:-]*" + }, + "federatedIdType":{ + "type":"string", + "min":2, + "max":96, + "pattern":"[\\w+=,.@\\:-]*" + }, + "idpCommunicationErrorMessage":{"type":"string"}, + "idpRejectedClaimMessage":{"type":"string"}, + "invalidAuthorizationMessage":{"type":"string"}, + "invalidIdentityTokenMessage":{"type":"string"}, + "malformedPolicyDocumentMessage":{"type":"string"}, + "nonNegativeIntegerType":{ + "type":"integer", + "min":0 + }, + "packedPolicyTooLargeMessage":{"type":"string"}, + "roleDurationSecondsType":{ + "type":"integer", + "min":900, + "max":3600 + }, + "serialNumberType":{ + "type":"string", + "min":9, + "max":256, + "pattern":"[\\w+=/:,.@-]*" + }, + "sessionPolicyDocumentType":{ + "type":"string", + "min":1, + "max":2048, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "tokenCodeType":{ + "type":"string", + "min":6, + "max":6, + "pattern":"[\\d]*" + }, + "tokenType":{"type":"string"}, + "urlType":{ + "type":"string", + "min":4, + "max":2048 + }, + "userNameType":{ + "type":"string", + "min":2, + "max":32, + "pattern":"[\\w+=,.@-]*" + }, + "webIdentitySubjectType":{ + "type":"string", + "min":6, + "max":255 + } + } +} diff --git a/apis/support-2013-04-15.api.json b/apis/support-2013-04-15.api.json new file mode 100644 index 0000000000..abe907690a --- /dev/null +++ b/apis/support-2013-04-15.api.json @@ -0,0 +1,569 @@ +{ + "metadata": { + "apiVersion": "2013-04-15", + "endpointPrefix": "support", + "jsonVersion": "1.1", + "serviceFullName": "AWS Support", + "signatureVersion": "v4", + "targetPrefix": "AWSSupport_20130415", + "protocol": "json" + }, + "operations": { + "AddAttachmentsToSet": { + "input": { + "type": "structure", + "required": [ + "attachments" + ], + "members": { + "attachmentSetId": {}, + "attachments": { + "type": "list", + "member": { + "shape": "S4" + } + } + } + }, + "output": { + "type": "structure", + "members": { + "attachmentSetId": {}, + "expiryTime": {} + } + } + }, + "AddCommunicationToCase": { + "input": { + "type": "structure", + "required": [ + "communicationBody" + ], + "members": { + "caseId": {}, + "communicationBody": {}, + "ccEmailAddresses": { + "shape": "Sc" + }, + "attachmentSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "result": { + "type": "boolean" + } + } + } + }, + "CreateCase": { + "input": { + "type": "structure", + "required": [ + "subject", + "communicationBody" + ], + "members": { + "subject": {}, + "serviceCode": {}, + "severityCode": {}, + "categoryCode": {}, + "communicationBody": {}, + "ccEmailAddresses": { + "shape": "Sc" + }, + "language": {}, + "issueType": {}, + "attachmentSetId": {} + } + }, + "output": { + "type": "structure", + "members": { + "caseId": {} + } + } + }, + "DescribeAttachment": { + "input": { + "type": "structure", + "required": [ + "attachmentId" + ], + "members": { + "attachmentId": {} + } + }, + "output": { + "type": "structure", + "members": { + "attachment": { + "shape": "S4" + } + } + } + }, + "DescribeCases": { + "input": { + "type": "structure", + "members": { + "caseIdList": { + "type": "list", + "member": {} + }, + "displayId": {}, + "afterTime": {}, + "beforeTime": {}, + "includeResolvedCases": { + "type": "boolean" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "language": {}, + "includeCommunications": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "cases": { + "type": "list", + "member": { + "type": "structure", + "members": { + "caseId": {}, + "displayId": {}, + "subject": {}, + "status": {}, + "serviceCode": {}, + "categoryCode": {}, + "severityCode": {}, + "submittedBy": {}, + "timeCreated": {}, + "recentCommunications": { + "type": "structure", + "members": { + "communications": { + "shape": "S17" + }, + "nextToken": {} + } + }, + "ccEmailAddresses": { + "shape": "Sc" + }, + "language": {} + } + } + }, + "nextToken": {} + } + } + }, + "DescribeCommunications": { + "input": { + "type": "structure", + "required": [ + "caseId" + ], + "members": { + "caseId": {}, + "beforeTime": {}, + "afterTime": {}, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "communications": { + "shape": "S17" + }, + "nextToken": {} + } + } + }, + "DescribeServices": { + "input": { + "type": "structure", + "members": { + "serviceCodeList": { + "type": "list", + "member": {} + }, + "language": {} + } + }, + "output": { + "type": "structure", + "members": { + "services": { + "type": "list", + "member": { + "type": "structure", + "members": { + "code": {}, + "name": {}, + "categories": { + "type": "list", + "member": { + "type": "structure", + "members": { + "code": {}, + "name": {} + } + } + } + } + } + } + } + } + }, + "DescribeSeverityLevels": { + "input": { + "type": "structure", + "members": { + "language": {} + } + }, + "output": { + "type": "structure", + "members": { + "severityLevels": { + "type": "list", + "member": { + "type": "structure", + "members": { + "code": {}, + "name": {} + } + } + } + } + } + }, + "DescribeTrustedAdvisorCheckRefreshStatuses": { + "input": { + "type": "structure", + "required": [ + "checkIds" + ], + "members": { + "checkIds": { + "shape": "S1t" + } + } + }, + "output": { + "type": "structure", + "required": [ + "statuses" + ], + "members": { + "statuses": { + "type": "list", + "member": { + "shape": "S1x" + } + } + } + } + }, + "DescribeTrustedAdvisorCheckResult": { + "input": { + "type": "structure", + "required": [ + "checkId" + ], + "members": { + "checkId": {}, + "language": {} + } + }, + "output": { + "type": "structure", + "members": { + "result": { + "type": "structure", + "required": [ + "checkId", + "timestamp", + "status", + "resourcesSummary", + "categorySpecificSummary", + "flaggedResources" + ], + "members": { + "checkId": {}, + "timestamp": {}, + "status": {}, + "resourcesSummary": { + "shape": "S22" + }, + "categorySpecificSummary": { + "shape": "S23" + }, + "flaggedResources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "status", + "region", + "resourceId", + "metadata" + ], + "members": { + "status": {}, + "region": {}, + "resourceId": {}, + "isSuppressed": { + "type": "boolean" + }, + "metadata": { + "shape": "S1t" + } + } + } + } + } + } + } + } + }, + "DescribeTrustedAdvisorCheckSummaries": { + "input": { + "type": "structure", + "required": [ + "checkIds" + ], + "members": { + "checkIds": { + "shape": "S1t" + } + } + }, + "output": { + "type": "structure", + "required": [ + "summaries" + ], + "members": { + "summaries": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "checkId", + "timestamp", + "status", + "resourcesSummary", + "categorySpecificSummary" + ], + "members": { + "checkId": {}, + "timestamp": {}, + "status": {}, + "hasFlaggedResources": { + "type": "boolean" + }, + "resourcesSummary": { + "shape": "S22" + }, + "categorySpecificSummary": { + "shape": "S23" + } + } + } + } + } + } + }, + "DescribeTrustedAdvisorChecks": { + "input": { + "type": "structure", + "required": [ + "language" + ], + "members": { + "language": {} + } + }, + "output": { + "type": "structure", + "required": [ + "checks" + ], + "members": { + "checks": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "id", + "name", + "description", + "category", + "metadata" + ], + "members": { + "id": {}, + "name": {}, + "description": {}, + "category": {}, + "metadata": { + "shape": "S1t" + } + } + } + } + } + } + }, + "RefreshTrustedAdvisorCheck": { + "input": { + "type": "structure", + "required": [ + "checkId" + ], + "members": { + "checkId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "S1x" + } + } + } + }, + "ResolveCase": { + "input": { + "type": "structure", + "members": { + "caseId": {} + } + }, + "output": { + "type": "structure", + "members": { + "initialCaseStatus": {}, + "finalCaseStatus": {} + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "fileName": {}, + "data": { + "type": "blob" + } + } + }, + "Sc": { + "type": "list", + "member": {} + }, + "S17": { + "type": "list", + "member": { + "type": "structure", + "members": { + "caseId": {}, + "body": {}, + "submittedBy": {}, + "timeCreated": {}, + "attachmentSet": { + "type": "list", + "member": { + "type": "structure", + "members": { + "attachmentId": {}, + "fileName": {} + } + } + } + } + } + }, + "S1t": { + "type": "list", + "member": {} + }, + "S1x": { + "type": "structure", + "required": [ + "checkId", + "status", + "millisUntilNextRefreshable" + ], + "members": { + "checkId": {}, + "status": {}, + "millisUntilNextRefreshable": { + "type": "long" + } + } + }, + "S22": { + "type": "structure", + "required": [ + "resourcesProcessed", + "resourcesFlagged", + "resourcesIgnored", + "resourcesSuppressed" + ], + "members": { + "resourcesProcessed": { + "type": "long" + }, + "resourcesFlagged": { + "type": "long" + }, + "resourcesIgnored": { + "type": "long" + }, + "resourcesSuppressed": { + "type": "long" + } + } + }, + "S23": { + "type": "structure", + "members": { + "costOptimizing": { + "type": "structure", + "required": [ + "estimatedMonthlySavings", + "estimatedPercentMonthlySavings" + ], + "members": { + "estimatedMonthlySavings": { + "type": "double" + }, + "estimatedPercentMonthlySavings": { + "type": "double" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/apis/support-2013-04-15.full.json b/apis/support-2013-04-15.full.json new file mode 100644 index 0000000000..7ec2ef8ee5 --- /dev/null +++ b/apis/support-2013-04-15.full.json @@ -0,0 +1,1379 @@ +{ + "metadata":{ + "apiVersion":"2013-04-15", + "endpointPrefix":"support", + "jsonVersion":"1.1", + "serviceFullName":"AWS Support", + "signatureVersion":"v4", + "targetPrefix":"AWSSupport_20130415", + "protocol":"json" + }, + "documentation":"AWS Support

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

The following list describes the AWS Support case management operations:

The following list describes the operations available from the AWS Support service for Trusted Advisor:

For authentication of requests, AWS Support uses Signature Version 4 Signing Process.

See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

", + "operations":{ + "AddAttachmentsToSet":{ + "name":"AddAttachmentsToSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddAttachmentsToSetRequest"}, + "output":{ + "shape":"AddAttachmentsToSetResponse", + "documentation":"

The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + }, + { + "shape":"AttachmentSetIdNotFound", + "exception":true, + "documentation":"

An attachment set with the specified ID could not be found.

" + }, + { + "shape":"AttachmentSetExpired", + "exception":true, + "documentation":"

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

" + }, + { + "shape":"AttachmentSetSizeLimitExceeded", + "exception":true, + "documentation":"

A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

" + }, + { + "shape":"AttachmentLimitExceeded", + "exception":true, + "documentation":"

The limit for the number of attachment sets created in a short period of time has been exceeded.

" + } + ], + "documentation":"

Adds one or more attachments to an attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the ExpiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

" + }, + "AddCommunicationToCase":{ + "name":"AddCommunicationToCase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddCommunicationToCaseRequest", + "documentation":"

To be written.

" + }, + "output":{ + "shape":"AddCommunicationToCaseResponse", + "documentation":"

The result of the AddCommunicationToCase operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + }, + { + "shape":"CaseIdNotFound", + "exception":true, + "documentation":"

The requested CaseId could not be located.

" + }, + { + "shape":"AttachmentSetIdNotFound", + "exception":true, + "documentation":"

An attachment set with the specified ID could not be found.

" + }, + { + "shape":"AttachmentSetExpired", + "exception":true, + "documentation":"

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

" + } + ], + "documentation":"

Adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody value contains the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the behavior on the AWS Support Your Support Cases web form.

" + }, + "CreateCase":{ + "name":"CreateCase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCaseRequest"}, + "output":{ + "shape":"CreateCaseResponse", + "documentation":"

The AWS Support case ID returned by a successful completion of the CreateCase operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + }, + { + "shape":"CaseCreationLimitExceeded", + "exception":true, + "documentation":"

The case creation limit for the account has been exceeded.

" + }, + { + "shape":"AttachmentSetIdNotFound", + "exception":true, + "documentation":"

An attachment set with the specified ID could not be found.

" + }, + { + "shape":"AttachmentSetExpired", + "exception":true, + "documentation":"

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

" + } + ], + "documentation":"

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Open a new case page. Its parameters require you to specify the following information:

  1. IssueType. The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\"
  2. ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
  3. CategoryCode. The category for the service defined for the ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
  4. SeverityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
  5. Subject. The Subject field on the AWS Support Center Open a new case page.
  6. CommunicationBody. The Description field on the AWS Support Center Open a new case page.
  7. AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
  8. Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
  9. CcEmailAddresses. The AWS Support Center CC field on the Open a new case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

" + }, + "DescribeAttachment":{ + "name":"DescribeAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAttachmentRequest"}, + "output":{ + "shape":"DescribeAttachmentResponse", + "documentation":"

The content and file name of the attachment returned by the DescribeAttachment operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + }, + { + "shape":"DescribeAttachmentLimitExceeded", + "exception":true, + "documentation":"

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

" + }, + { + "shape":"AttachmentIdNotFound", + "exception":true, + "documentation":"

An attachment with the specified ID could not be found.

" + } + ], + "documentation":"

Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

" + }, + "DescribeCases":{ + "name":"DescribeCases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCasesRequest"}, + "output":{ + "shape":"DescribeCasesResponse", + "documentation":"

Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + }, + { + "shape":"CaseIdNotFound", + "exception":true, + "documentation":"

The requested CaseId could not be located.

" + } + ], + "documentation":"

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

The response returns the following in JSON format:

  1. One or more CaseDetails data types.
  2. One or more NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.
" + }, + "DescribeCommunications":{ + "name":"DescribeCommunications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCommunicationsRequest"}, + "output":{ + "shape":"DescribeCommunicationsResponse", + "documentation":"

The communications returned by the DescribeCommunications operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + }, + { + "shape":"CaseIdNotFound", + "exception":true, + "documentation":"

The requested CaseId could not be located.

" + } + ], + "documentation":"

Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId parameter to restrict the results to a particular case.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

You can use the MaxResults and NextToken parameters to control the pagination of the result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

" + }, + "DescribeServices":{ + "name":"DescribeServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServicesRequest"}, + "output":{ + "shape":"DescribeServicesResponse", + "documentation":"

The list of AWS services returned by the DescribeServices operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + } + ], + "documentation":"

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Open a new case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

" + }, + "DescribeSeverityLevels":{ + "name":"DescribeSeverityLevels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSeverityLevelsRequest"}, + "output":{ + "shape":"DescribeSeverityLevelsResponse", + "documentation":"

The list of severity levels returned by the DescribeSeverityLevels operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + } + ], + "documentation":"

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

" + }, + "DescribeTrustedAdvisorCheckRefreshStatuses":{ + "name":"DescribeTrustedAdvisorCheckRefreshStatuses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesRequest"}, + "output":{ + "shape":"DescribeTrustedAdvisorCheckRefreshStatusesResponse", + "documentation":"

The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + } + ], + "documentation":"

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

" + }, + "DescribeTrustedAdvisorCheckResult":{ + "name":"DescribeTrustedAdvisorCheckResult", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustedAdvisorCheckResultRequest"}, + "output":{ + "shape":"DescribeTrustedAdvisorCheckResultResponse", + "documentation":"

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + } + ], + "documentation":"

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

In addition, the response contains these fields:

" + }, + "DescribeTrustedAdvisorCheckSummaries":{ + "name":"DescribeTrustedAdvisorCheckSummaries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustedAdvisorCheckSummariesRequest"}, + "output":{ + "shape":"DescribeTrustedAdvisorCheckSummariesResponse", + "documentation":"

The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + } + ], + "documentation":"

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

" + }, + "DescribeTrustedAdvisorChecks":{ + "name":"DescribeTrustedAdvisorChecks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustedAdvisorChecksRequest"}, + "output":{ + "shape":"DescribeTrustedAdvisorChecksResponse", + "documentation":"

Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + } + ], + "documentation":"

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English (\"en\") and Japanese (\"ja\") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.

" + }, + "RefreshTrustedAdvisorCheck":{ + "name":"RefreshTrustedAdvisorCheck", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RefreshTrustedAdvisorCheckRequest"}, + "output":{ + "shape":"RefreshTrustedAdvisorCheckResponse", + "documentation":"

The current refresh status of a Trusted Advisor check.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + } + ], + "documentation":"

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a RefreshTrustedAdvisorCheckResult object, which contains these fields:

" + }, + "ResolveCase":{ + "name":"ResolveCase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResolveCaseRequest"}, + "output":{ + "shape":"ResolveCaseResponse", + "documentation":"

The status of the case returned by the ResolveCase operation.

" + }, + "errors":[ + { + "shape":"InternalServerError", + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + }, + { + "shape":"CaseIdNotFound", + "exception":true, + "documentation":"

The requested CaseId could not be located.

" + } + ], + "documentation":"

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

" + } + }, + "shapes":{ + "AddAttachmentsToSetRequest":{ + "type":"structure", + "required":["attachments"], + "members":{ + "attachmentSetId":{ + "shape":"AttachmentSetId", + "documentation":"

The ID of the attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.

" + }, + "attachments":{ + "shape":"Attachments", + "documentation":"

One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.

" + } + } + }, + "AddAttachmentsToSetResponse":{ + "type":"structure", + "members":{ + "attachmentSetId":{ + "shape":"AttachmentSetId", + "documentation":"

The ID of the attachment set. If an AttachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId was specified, the attachments are added to the specified set, if it exists.

" + }, + "expiryTime":{ + "shape":"ExpiryTime", + "documentation":"

The time and date when the attachment set expires.

" + } + }, + "documentation":"

The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

" + }, + "AddCommunicationToCaseRequest":{ + "type":"structure", + "required":["communicationBody"], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" + }, + "communicationBody":{ + "shape":"CommunicationBody", + "documentation":"

The body of an email communication to add to the support case.

" + }, + "ccEmailAddresses":{ + "shape":"CcEmailAddressList", + "documentation":"

The email addresses in the CC line of an email to be added to the support case.

" + }, + "attachmentSetId":{ + "shape":"AttachmentSetId", + "documentation":"

The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet

" + } + }, + "documentation":"

To be written.

" + }, + "AddCommunicationToCaseResponse":{ + "type":"structure", + "members":{ + "result":{ + "shape":"Result", + "documentation":"

True if AddCommunicationToCase succeeds. Otherwise, returns an error.

" + } + }, + "documentation":"

The result of the AddCommunicationToCase operation.

" + }, + "AfterTime":{"type":"string"}, + "Attachment":{ + "type":"structure", + "members":{ + "fileName":{ + "shape":"FileName", + "documentation":"

The name of the attachment file.

" + }, + "data":{ + "shape":"Data", + "documentation":"

The content of the attachment file.

" + } + }, + "documentation":"

An attachment to a case communication. The attachment consists of the file name and the content of the file.

" + }, + "AttachmentDetails":{ + "type":"structure", + "members":{ + "attachmentId":{ + "shape":"AttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "fileName":{ + "shape":"FileName", + "documentation":"

The file name of the attachment.

" + } + }, + "documentation":"

The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

" + }, + "AttachmentId":{"type":"string"}, + "AttachmentIdNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

An attachment with the specified ID could not be found.

" + } + }, + "exception":true, + "documentation":"

An attachment with the specified ID could not be found.

" + }, + "AttachmentLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The limit for the number of attachment sets created in a short period of time has been exceeded.

" + } + }, + "exception":true, + "documentation":"

The limit for the number of attachment sets created in a short period of time has been exceeded.

" + }, + "AttachmentSet":{ + "type":"list", + "member":{"shape":"AttachmentDetails"} + }, + "AttachmentSetExpired":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

" + } + }, + "exception":true, + "documentation":"

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

" + }, + "AttachmentSetId":{"type":"string"}, + "AttachmentSetIdNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

An attachment set with the specified ID could not be found.

" + } + }, + "exception":true, + "documentation":"

An attachment set with the specified ID could not be found.

" + }, + "AttachmentSetSizeLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

" + } + }, + "exception":true, + "documentation":"

A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

" + }, + "Attachments":{ + "type":"list", + "member":{"shape":"Attachment"} + }, + "BeforeTime":{"type":"string"}, + "Boolean":{"type":"boolean"}, + "CaseCreationLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

An error message that indicates that you have exceeded the number of cases you can have open.

" + } + }, + "exception":true, + "documentation":"

The case creation limit for the account has been exceeded.

" + }, + "CaseDetails":{ + "type":"structure", + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" + }, + "displayId":{ + "shape":"DisplayId", + "documentation":"

The ID displayed for the case in the AWS Support Center. This is a numeric string.

" + }, + "subject":{ + "shape":"Subject", + "documentation":"

The subject line for the case in the AWS Support Center.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the case.

" + }, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"

The code for the AWS service returned by the call to DescribeServices.

" + }, + "categoryCode":{ + "shape":"CategoryCode", + "documentation":"

The category of problem for the AWS Support case.

" + }, + "severityCode":{ + "shape":"SeverityCode", + "documentation":"

The code for the severity level returned by the call to DescribeSeverityLevels.

" + }, + "submittedBy":{ + "shape":"SubmittedBy", + "documentation":"

The email address of the account that submitted the case.

" + }, + "timeCreated":{ + "shape":"TimeCreated", + "documentation":"

The time that the case was case created in the AWS Support Center.

" + }, + "recentCommunications":{ + "shape":"RecentCaseCommunications", + "documentation":"

The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

" + }, + "ccEmailAddresses":{ + "shape":"CcEmailAddressList", + "documentation":"

The email addresses that receive copies of communication about the case.

" + }, + "language":{ + "shape":"Language", + "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" + } + }, + "documentation":"

A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:

  1. CaseID. The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.
  2. CategoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.
  3. DisplayId. The identifier for the case on pages in the AWS Support Center.
  4. Language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
  5. RecentCommunications. One or more Communication objects. Fields of these objects are Attachments, Body, CaseId, SubmittedBy, and TimeCreated.
  6. NextToken. A resumption point for pagination.
  7. ServiceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.
  8. SeverityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels.
  9. Status. The status of the case in the AWS Support Center.
  10. Subject. The subject line of the case.
  11. SubmittedBy. The email address of the account that submitted the case.
  12. TimeCreated. The time the case was created, in ISO-8601 format.
" + }, + "CaseId":{"type":"string"}, + "CaseIdList":{ + "type":"list", + "member":{"shape":"CaseId"}, + "min":0, + "max":100 + }, + "CaseIdNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The requested CaseId could not be located.

" + } + }, + "exception":true, + "documentation":"

The requested CaseId could not be located.

" + }, + "CaseList":{ + "type":"list", + "member":{"shape":"CaseDetails"} + }, + "CaseStatus":{"type":"string"}, + "Category":{ + "type":"structure", + "members":{ + "code":{ + "shape":"CategoryCode", + "documentation":"

The category code for the support case.

" + }, + "name":{ + "shape":"CategoryName", + "documentation":"

The category name for the support case.

" + } + }, + "documentation":"

A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.

" + }, + "CategoryCode":{"type":"string"}, + "CategoryList":{ + "type":"list", + "member":{"shape":"Category"} + }, + "CategoryName":{"type":"string"}, + "CcEmailAddress":{"type":"string"}, + "CcEmailAddressList":{ + "type":"list", + "member":{"shape":"CcEmailAddress"} + }, + "Communication":{ + "type":"structure", + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" + }, + "body":{ + "shape":"CommunicationBody", + "documentation":"

The text of the communication between the customer and AWS Support.

" + }, + "submittedBy":{ + "shape":"SubmittedBy", + "documentation":"

The email address of the account that submitted the AWS Support case.

" + }, + "timeCreated":{ + "shape":"TimeCreated", + "documentation":"

The time the communication was created.

" + }, + "attachmentSet":{ + "shape":"AttachmentSet", + "documentation":"

Information about the attachments to the case communication.

" + } + }, + "documentation":"

A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

" + }, + "CommunicationBody":{"type":"string"}, + "CommunicationList":{ + "type":"list", + "member":{"shape":"Communication"} + }, + "CreateCaseRequest":{ + "type":"structure", + "required":[ + "subject", + "communicationBody" + ], + "members":{ + "subject":{ + "shape":"Subject", + "documentation":"

The title of the AWS Support case.

" + }, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"

The code for the AWS service returned by the call to DescribeServices.

" + }, + "severityCode":{ + "shape":"SeverityCode", + "documentation":"

The code for the severity level returned by the call to DescribeSeverityLevels.

" + }, + "categoryCode":{ + "shape":"CategoryCode", + "documentation":"

The category of problem for the AWS Support case.

" + }, + "communicationBody":{ + "shape":"CommunicationBody", + "documentation":"

The communication body text when you create an AWS Support case by calling CreateCase.

" + }, + "ccEmailAddresses":{ + "shape":"CcEmailAddressList", + "documentation":"

A list of email addresses that AWS Support copies on case correspondence.

" + }, + "language":{ + "shape":"Language", + "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" + }, + "issueType":{ + "shape":"IssueType", + "documentation":"

The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\"

" + }, + "attachmentSetId":{ + "shape":"AttachmentSetId", + "documentation":"

The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.

" + } + } + }, + "CreateCaseResponse":{ + "type":"structure", + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" + } + }, + "documentation":"

The AWS Support case ID returned by a successful completion of the CreateCase operation.

" + }, + "Data":{"type":"blob"}, + "DescribeAttachmentLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

" + } + }, + "exception":true, + "documentation":"

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

" + }, + "DescribeAttachmentRequest":{ + "type":"structure", + "required":["attachmentId"], + "members":{ + "attachmentId":{ + "shape":"AttachmentId", + "documentation":"

The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

" + } + } + }, + "DescribeAttachmentResponse":{ + "type":"structure", + "members":{ + "attachment":{ + "shape":"Attachment", + "documentation":"

The attachment content and file name.

" + } + }, + "documentation":"

The content and file name of the attachment returned by the DescribeAttachment operation.

" + }, + "DescribeCasesRequest":{ + "type":"structure", + "members":{ + "caseIdList":{ + "shape":"CaseIdList", + "documentation":"

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

" + }, + "displayId":{ + "shape":"DisplayId", + "documentation":"

The ID displayed for a case in the AWS Support Center user interface.

" + }, + "afterTime":{ + "shape":"AfterTime", + "documentation":"

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" + }, + "beforeTime":{ + "shape":"BeforeTime", + "documentation":"

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" + }, + "includeResolvedCases":{ + "shape":"IncludeResolvedCases", + "documentation":"

Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A resumption point for pagination.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return before paginating.

" + }, + "language":{ + "shape":"Language", + "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" + }, + "includeCommunications":{ + "shape":"IncludeCommunications", + "documentation":"

Specifies whether communications should be included in the DescribeCases results. The default is true.

" + } + } + }, + "DescribeCasesResponse":{ + "type":"structure", + "members":{ + "cases":{ + "shape":"CaseList", + "documentation":"

The details for the cases that match the request.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A resumption point for pagination.

" + } + }, + "documentation":"

Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set.

" + }, + "DescribeCommunicationsRequest":{ + "type":"structure", + "required":["caseId"], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" + }, + "beforeTime":{ + "shape":"BeforeTime", + "documentation":"

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" + }, + "afterTime":{ + "shape":"AfterTime", + "documentation":"

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A resumption point for pagination.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return before paginating.

" + } + } + }, + "DescribeCommunicationsResponse":{ + "type":"structure", + "members":{ + "communications":{ + "shape":"CommunicationList", + "documentation":"

The communications for the case.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A resumption point for pagination.

" + } + }, + "documentation":"

The communications returned by the DescribeCommunications operation.

" + }, + "DescribeServicesRequest":{ + "type":"structure", + "members":{ + "serviceCodeList":{ + "shape":"ServiceCodeList", + "documentation":"

A JSON-formatted list of service codes available for AWS services.

" + }, + "language":{ + "shape":"Language", + "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" + } + } + }, + "DescribeServicesResponse":{ + "type":"structure", + "members":{ + "services":{ + "shape":"ServiceList", + "documentation":"

A JSON-formatted list of AWS services.

" + } + }, + "documentation":"

The list of AWS services returned by the DescribeServices operation.

" + }, + "DescribeSeverityLevelsRequest":{ + "type":"structure", + "members":{ + "language":{ + "shape":"Language", + "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" + } + } + }, + "DescribeSeverityLevelsResponse":{ + "type":"structure", + "members":{ + "severityLevels":{ + "shape":"SeverityLevelsList", + "documentation":"

The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.

" + } + }, + "documentation":"

The list of severity levels returned by the DescribeSeverityLevels operation.

" + }, + "DescribeTrustedAdvisorCheckRefreshStatusesRequest":{ + "type":"structure", + "required":["checkIds"], + "members":{ + "checkIds":{ + "shape":"StringList", + "documentation":"

The IDs of the Trusted Advisor checks.

" + } + } + }, + "DescribeTrustedAdvisorCheckRefreshStatusesResponse":{ + "type":"structure", + "required":["statuses"], + "members":{ + "statuses":{ + "shape":"TrustedAdvisorCheckRefreshStatusList", + "documentation":"

The refresh status of the specified Trusted Advisor checks.

" + } + }, + "documentation":"

The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

" + }, + "DescribeTrustedAdvisorCheckResultRequest":{ + "type":"structure", + "required":["checkId"], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

The unique identifier for the Trusted Advisor check.

" + }, + "language":{ + "shape":"String", + "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" + } + } + }, + "DescribeTrustedAdvisorCheckResultResponse":{ + "type":"structure", + "members":{ + "result":{ + "shape":"TrustedAdvisorCheckResult", + "documentation":"

The detailed results of the Trusted Advisor check.

" + } + }, + "documentation":"

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

" + }, + "DescribeTrustedAdvisorCheckSummariesRequest":{ + "type":"structure", + "required":["checkIds"], + "members":{ + "checkIds":{ + "shape":"StringList", + "documentation":"

The IDs of the Trusted Advisor checks.

" + } + } + }, + "DescribeTrustedAdvisorCheckSummariesResponse":{ + "type":"structure", + "required":["summaries"], + "members":{ + "summaries":{ + "shape":"TrustedAdvisorCheckSummaryList", + "documentation":"

The summary information for the requested Trusted Advisor checks.

" + } + }, + "documentation":"

The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

" + }, + "DescribeTrustedAdvisorChecksRequest":{ + "type":"structure", + "required":["language"], + "members":{ + "language":{ + "shape":"String", + "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" + } + } + }, + "DescribeTrustedAdvisorChecksResponse":{ + "type":"structure", + "required":["checks"], + "members":{ + "checks":{ + "shape":"TrustedAdvisorCheckList", + "documentation":"

Information about all available Trusted Advisor checks.

" + } + }, + "documentation":"

Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

" + }, + "DisplayId":{"type":"string"}, + "Double":{"type":"double"}, + "ErrorMessage":{"type":"string"}, + "ExpiryTime":{"type":"string"}, + "FileName":{"type":"string"}, + "IncludeCommunications":{"type":"boolean"}, + "IncludeResolvedCases":{"type":"boolean"}, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

An internal server error occurred.

" + } + }, + "exception":true, + "fault":true, + "documentation":"

An internal server error occurred.

" + }, + "IssueType":{"type":"string"}, + "Language":{"type":"string"}, + "Long":{"type":"long"}, + "MaxResults":{ + "type":"integer", + "min":10, + "max":100 + }, + "NextToken":{"type":"string"}, + "RecentCaseCommunications":{ + "type":"structure", + "members":{ + "communications":{ + "shape":"CommunicationList", + "documentation":"

The five most recent communications associated with the case.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A resumption point for pagination.

" + } + }, + "documentation":"

The five most recent communications associated with the case.

" + }, + "RefreshTrustedAdvisorCheckRequest":{ + "type":"structure", + "required":["checkId"], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

The unique identifier for the Trusted Advisor check.

" + } + } + }, + "RefreshTrustedAdvisorCheckResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"TrustedAdvisorCheckRefreshStatus", + "documentation":"

The current refresh status for a check, including the amount of time until the check is eligible for refresh.

" + } + }, + "documentation":"

The current refresh status of a Trusted Advisor check.

" + }, + "ResolveCaseRequest":{ + "type":"structure", + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" + } + } + }, + "ResolveCaseResponse":{ + "type":"structure", + "members":{ + "initialCaseStatus":{ + "shape":"CaseStatus", + "documentation":"

The status of the case when the ResolveCase request was sent.

" + }, + "finalCaseStatus":{ + "shape":"CaseStatus", + "documentation":"

The status of the case after the ResolveCase request was processed.

" + } + }, + "documentation":"

The status of the case returned by the ResolveCase operation.

" + }, + "Result":{"type":"boolean"}, + "Service":{ + "type":"structure", + "members":{ + "code":{ + "shape":"ServiceCode", + "documentation":"

The code for an AWS service returned by the DescribeServices response. The Name element contains the corresponding friendly name.

" + }, + "name":{ + "shape":"ServiceName", + "documentation":"

The friendly name for an AWS service. The Code element contains the corresponding code.

" + }, + "categories":{ + "shape":"CategoryList", + "documentation":"

A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.

" + } + }, + "documentation":"

Information about an AWS service returned by the DescribeServices operation.

" + }, + "ServiceCode":{ + "type":"string", + "pattern":"[0-9a-z\\-_]+" + }, + "ServiceCodeList":{ + "type":"list", + "member":{"shape":"ServiceCode"}, + "min":0, + "max":100 + }, + "ServiceList":{ + "type":"list", + "member":{"shape":"Service"} + }, + "ServiceName":{"type":"string"}, + "SeverityCode":{"type":"string"}, + "SeverityLevel":{ + "type":"structure", + "members":{ + "code":{ + "shape":"SeverityLevelCode", + "documentation":"

One of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in SeverityLevel.name.

" + }, + "name":{ + "shape":"SeverityLevelName", + "documentation":"

The name of the severity level that corresponds to the severity level code.

" + } + }, + "documentation":"

A code and name pair that represent a severity level that can be applied to a support case.

" + }, + "SeverityLevelCode":{"type":"string"}, + "SeverityLevelName":{"type":"string"}, + "SeverityLevelsList":{ + "type":"list", + "member":{"shape":"SeverityLevel"} + }, + "Status":{"type":"string"}, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Subject":{"type":"string"}, + "SubmittedBy":{"type":"string"}, + "TimeCreated":{"type":"string"}, + "TrustedAdvisorCategorySpecificSummary":{ + "type":"structure", + "members":{ + "costOptimizing":{ + "shape":"TrustedAdvisorCostOptimizingSummary", + "documentation":"

The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

" + } + }, + "documentation":"

The container for summary information that relates to the category of the Trusted Advisor check.

" + }, + "TrustedAdvisorCheckDescription":{ + "type":"structure", + "required":[ + "id", + "name", + "description", + "category", + "metadata" + ], + "members":{ + "id":{ + "shape":"String", + "documentation":"

The unique identifier for the Trusted Advisor check.

" + }, + "name":{ + "shape":"String", + "documentation":"

The display name for the Trusted Advisor check.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).

" + }, + "category":{ + "shape":"String", + "documentation":"

The category of the Trusted Advisor check.

" + }, + "metadata":{ + "shape":"StringList", + "documentation":"

The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

" + } + }, + "documentation":"

The description and metadata for a Trusted Advisor check.

" + }, + "TrustedAdvisorCheckList":{ + "type":"list", + "member":{"shape":"TrustedAdvisorCheckDescription"} + }, + "TrustedAdvisorCheckRefreshStatus":{ + "type":"structure", + "required":[ + "checkId", + "status", + "millisUntilNextRefreshable" + ], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

The unique identifier for the Trusted Advisor check.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".

" + }, + "millisUntilNextRefreshable":{ + "shape":"Long", + "documentation":"

The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

" + } + }, + "documentation":"

The refresh status of a Trusted Advisor check.

" + }, + "TrustedAdvisorCheckRefreshStatusList":{ + "type":"list", + "member":{"shape":"TrustedAdvisorCheckRefreshStatus"} + }, + "TrustedAdvisorCheckResult":{ + "type":"structure", + "required":[ + "checkId", + "timestamp", + "status", + "resourcesSummary", + "categorySpecificSummary", + "flaggedResources" + ], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

The unique identifier for the Trusted Advisor check.

" + }, + "timestamp":{ + "shape":"String", + "documentation":"

The time of the last refresh of the check.

" + }, + "status":{ + "shape":"String", + "documentation":"

The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

" + }, + "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, + "categorySpecificSummary":{ + "shape":"TrustedAdvisorCategorySpecificSummary", + "documentation":"

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

" + }, + "flaggedResources":{ + "shape":"TrustedAdvisorResourceDetailList", + "documentation":"

The details about each resource listed in the check result.

" + } + }, + "documentation":"

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

" + }, + "TrustedAdvisorCheckSummary":{ + "type":"structure", + "required":[ + "checkId", + "timestamp", + "status", + "resourcesSummary", + "categorySpecificSummary" + ], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

The unique identifier for the Trusted Advisor check.

" + }, + "timestamp":{ + "shape":"String", + "documentation":"

The time of the last refresh of the check.

" + }, + "status":{ + "shape":"String", + "documentation":"

The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

" + }, + "hasFlaggedResources":{ + "shape":"Boolean", + "documentation":"

Specifies whether the Trusted Advisor check has flagged resources.

" + }, + "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, + "categorySpecificSummary":{ + "shape":"TrustedAdvisorCategorySpecificSummary", + "documentation":"

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

" + } + }, + "documentation":"

A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

" + }, + "TrustedAdvisorCheckSummaryList":{ + "type":"list", + "member":{"shape":"TrustedAdvisorCheckSummary"} + }, + "TrustedAdvisorCostOptimizingSummary":{ + "type":"structure", + "required":[ + "estimatedMonthlySavings", + "estimatedPercentMonthlySavings" + ], + "members":{ + "estimatedMonthlySavings":{ + "shape":"Double", + "documentation":"

The estimated monthly savings that might be realized if the recommended actions are taken.

" + }, + "estimatedPercentMonthlySavings":{ + "shape":"Double", + "documentation":"

The estimated percentage of savings that might be realized if the recommended actions are taken.

" + } + }, + "documentation":"

The estimated cost savings that might be realized if the recommended actions are taken.

" + }, + "TrustedAdvisorResourceDetail":{ + "type":"structure", + "required":[ + "status", + "region", + "resourceId", + "metadata" + ], + "members":{ + "status":{ + "shape":"String", + "documentation":"

The status code for the resource identified in the Trusted Advisor check.

" + }, + "region":{ + "shape":"String", + "documentation":"

The AWS region in which the identified resource is located.

" + }, + "resourceId":{ + "shape":"String", + "documentation":"

The unique identifier for the identified resource.

" + }, + "isSuppressed":{ + "shape":"Boolean", + "documentation":"

Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

" + }, + "metadata":{ + "shape":"StringList", + "documentation":"

Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

" + } + }, + "documentation":"

Contains information about a resource identified by a Trusted Advisor check.

" + }, + "TrustedAdvisorResourceDetailList":{ + "type":"list", + "member":{"shape":"TrustedAdvisorResourceDetail"} + }, + "TrustedAdvisorResourcesSummary":{ + "type":"structure", + "required":[ + "resourcesProcessed", + "resourcesFlagged", + "resourcesIgnored", + "resourcesSuppressed" + ], + "members":{ + "resourcesProcessed":{ + "shape":"Long", + "documentation":"

The number of AWS resources that were analyzed by the Trusted Advisor check.

" + }, + "resourcesFlagged":{ + "shape":"Long", + "documentation":"

The number of AWS resources that were flagged (listed) by the Trusted Advisor check.

" + }, + "resourcesIgnored":{ + "shape":"Long", + "documentation":"

The number of AWS resources ignored by Trusted Advisor because information was unavailable.

" + }, + "resourcesSuppressed":{ + "shape":"Long", + "documentation":"

The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.

" + } + }, + "documentation":"

Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

" + } + } +} diff --git a/apis/support-2013-04-15.paginators.json b/apis/support-2013-04-15.paginators.json new file mode 100644 index 0000000000..1368630c84 --- /dev/null +++ b/apis/support-2013-04-15.paginators.json @@ -0,0 +1,25 @@ +{ + "pagination": { + "DescribeCases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "cases" + }, + "DescribeCommunications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "communications" + }, + "DescribeServices": { + "result_key": "services" + }, + "DescribeTrustedAdvisorCheckRefreshStatuses": { + "result_key": "statuses" + }, + "DescribeTrustedAdvisorCheckSummaries": { + "result_key": "summaries" + } + } +} diff --git a/apis/swf-2012-01-25.api.json b/apis/swf-2012-01-25.api.json new file mode 100644 index 0000000000..75b6005a41 --- /dev/null +++ b/apis/swf-2012-01-25.api.json @@ -0,0 +1,2072 @@ +{ + "metadata": { + "apiVersion": "2012-01-25", + "endpointPrefix": "swf", + "jsonVersion": "1.0", + "serviceAbbreviation": "Amazon SWF", + "serviceFullName": "Amazon Simple Workflow Service", + "signatureVersion": "v4", + "targetPrefix": "SimpleWorkflowService", + "timestampFormat": "unixTimestamp", + "protocol": "json" + }, + "operations": { + "CountClosedWorkflowExecutions": { + "input": { + "type": "structure", + "required": [ + "domain" + ], + "members": { + "domain": {}, + "startTimeFilter": { + "shape": "S3" + }, + "closeTimeFilter": { + "shape": "S3" + }, + "executionFilter": { + "shape": "S5" + }, + "typeFilter": { + "shape": "S7" + }, + "tagFilter": { + "shape": "Sa" + }, + "closeStatusFilter": { + "shape": "Sc" + } + } + }, + "output": { + "shape": "Se" + } + }, + "CountOpenWorkflowExecutions": { + "input": { + "type": "structure", + "required": [ + "domain", + "startTimeFilter" + ], + "members": { + "domain": {}, + "startTimeFilter": { + "shape": "S3" + }, + "typeFilter": { + "shape": "S7" + }, + "tagFilter": { + "shape": "Sa" + }, + "executionFilter": { + "shape": "S5" + } + } + }, + "output": { + "shape": "Se" + } + }, + "CountPendingActivityTasks": { + "input": { + "type": "structure", + "required": [ + "domain", + "taskList" + ], + "members": { + "domain": {}, + "taskList": { + "shape": "Sj" + } + } + }, + "output": { + "shape": "Sk" + } + }, + "CountPendingDecisionTasks": { + "input": { + "type": "structure", + "required": [ + "domain", + "taskList" + ], + "members": { + "domain": {}, + "taskList": { + "shape": "Sj" + } + } + }, + "output": { + "shape": "Sk" + } + }, + "DeprecateActivityType": { + "input": { + "type": "structure", + "required": [ + "domain", + "activityType" + ], + "members": { + "domain": {}, + "activityType": { + "shape": "Sn" + } + } + } + }, + "DeprecateDomain": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + } + }, + "DeprecateWorkflowType": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowType" + ], + "members": { + "domain": {}, + "workflowType": { + "shape": "Sr" + } + } + } + }, + "DescribeActivityType": { + "input": { + "type": "structure", + "required": [ + "domain", + "activityType" + ], + "members": { + "domain": {}, + "activityType": { + "shape": "Sn" + } + } + }, + "output": { + "type": "structure", + "required": [ + "typeInfo", + "configuration" + ], + "members": { + "typeInfo": { + "shape": "Su" + }, + "configuration": { + "type": "structure", + "members": { + "defaultTaskStartToCloseTimeout": {}, + "defaultTaskHeartbeatTimeout": {}, + "defaultTaskList": { + "shape": "Sj" + }, + "defaultTaskScheduleToStartTimeout": {}, + "defaultTaskScheduleToCloseTimeout": {} + } + } + } + } + }, + "DescribeDomain": { + "input": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + }, + "output": { + "type": "structure", + "required": [ + "domainInfo", + "configuration" + ], + "members": { + "domainInfo": { + "shape": "S11" + }, + "configuration": { + "type": "structure", + "required": [ + "workflowExecutionRetentionPeriodInDays" + ], + "members": { + "workflowExecutionRetentionPeriodInDays": {} + } + } + } + } + }, + "DescribeWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "execution" + ], + "members": { + "domain": {}, + "execution": { + "shape": "S15" + } + } + }, + "output": { + "type": "structure", + "required": [ + "executionInfo", + "executionConfiguration", + "openCounts" + ], + "members": { + "executionInfo": { + "shape": "S18" + }, + "executionConfiguration": { + "type": "structure", + "required": [ + "taskStartToCloseTimeout", + "executionStartToCloseTimeout", + "taskList", + "childPolicy" + ], + "members": { + "taskStartToCloseTimeout": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "childPolicy": {} + } + }, + "openCounts": { + "type": "structure", + "required": [ + "openActivityTasks", + "openDecisionTasks", + "openTimers", + "openChildWorkflowExecutions" + ], + "members": { + "openActivityTasks": { + "type": "integer" + }, + "openDecisionTasks": { + "type": "integer" + }, + "openTimers": { + "type": "integer" + }, + "openChildWorkflowExecutions": { + "type": "integer" + } + } + }, + "latestActivityTaskTimestamp": { + "type": "timestamp" + }, + "latestExecutionContext": {} + } + } + }, + "DescribeWorkflowType": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowType" + ], + "members": { + "domain": {}, + "workflowType": { + "shape": "Sr" + } + } + }, + "output": { + "type": "structure", + "required": [ + "typeInfo", + "configuration" + ], + "members": { + "typeInfo": { + "shape": "S1k" + }, + "configuration": { + "type": "structure", + "members": { + "defaultTaskStartToCloseTimeout": {}, + "defaultExecutionStartToCloseTimeout": {}, + "defaultTaskList": { + "shape": "Sj" + }, + "defaultChildPolicy": {} + } + } + } + } + }, + "GetWorkflowExecutionHistory": { + "input": { + "type": "structure", + "required": [ + "domain", + "execution" + ], + "members": { + "domain": {}, + "execution": { + "shape": "S15" + }, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "events" + ], + "members": { + "events": { + "shape": "S1r" + }, + "nextPageToken": {} + } + } + }, + "ListActivityTypes": { + "input": { + "type": "structure", + "required": [ + "domain", + "registrationStatus" + ], + "members": { + "domain": {}, + "name": {}, + "registrationStatus": {}, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "typeInfos" + ], + "members": { + "typeInfos": { + "type": "list", + "member": { + "shape": "Su" + } + }, + "nextPageToken": {} + } + } + }, + "ListClosedWorkflowExecutions": { + "input": { + "type": "structure", + "required": [ + "domain" + ], + "members": { + "domain": {}, + "startTimeFilter": { + "shape": "S3" + }, + "closeTimeFilter": { + "shape": "S3" + }, + "executionFilter": { + "shape": "S5" + }, + "closeStatusFilter": { + "shape": "Sc" + }, + "typeFilter": { + "shape": "S7" + }, + "tagFilter": { + "shape": "Sa" + }, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "shape": "S40" + } + }, + "ListDomains": { + "input": { + "type": "structure", + "required": [ + "registrationStatus" + ], + "members": { + "nextPageToken": {}, + "registrationStatus": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "domainInfos" + ], + "members": { + "domainInfos": { + "type": "list", + "member": { + "shape": "S11" + } + }, + "nextPageToken": {} + } + } + }, + "ListOpenWorkflowExecutions": { + "input": { + "type": "structure", + "required": [ + "domain", + "startTimeFilter" + ], + "members": { + "domain": {}, + "startTimeFilter": { + "shape": "S3" + }, + "typeFilter": { + "shape": "S7" + }, + "tagFilter": { + "shape": "Sa" + }, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + }, + "executionFilter": { + "shape": "S5" + } + } + }, + "output": { + "shape": "S40" + } + }, + "ListWorkflowTypes": { + "input": { + "type": "structure", + "required": [ + "domain", + "registrationStatus" + ], + "members": { + "domain": {}, + "name": {}, + "registrationStatus": {}, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "typeInfos" + ], + "members": { + "typeInfos": { + "type": "list", + "member": { + "shape": "S1k" + } + }, + "nextPageToken": {} + } + } + }, + "PollForActivityTask": { + "input": { + "type": "structure", + "required": [ + "domain", + "taskList" + ], + "members": { + "domain": {}, + "taskList": { + "shape": "Sj" + }, + "identity": {} + } + }, + "output": { + "type": "structure", + "required": [ + "taskToken", + "activityId", + "startedEventId", + "workflowExecution", + "activityType" + ], + "members": { + "taskToken": {}, + "activityId": {}, + "startedEventId": { + "type": "long" + }, + "workflowExecution": { + "shape": "S15" + }, + "activityType": { + "shape": "Sn" + }, + "input": {} + } + } + }, + "PollForDecisionTask": { + "input": { + "type": "structure", + "required": [ + "domain", + "taskList" + ], + "members": { + "domain": {}, + "taskList": { + "shape": "Sj" + }, + "identity": {}, + "nextPageToken": {}, + "maximumPageSize": { + "type": "integer" + }, + "reverseOrder": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "taskToken", + "startedEventId", + "workflowExecution", + "workflowType", + "events" + ], + "members": { + "taskToken": {}, + "startedEventId": { + "type": "long" + }, + "workflowExecution": { + "shape": "S15" + }, + "workflowType": { + "shape": "Sr" + }, + "events": { + "shape": "S1r" + }, + "nextPageToken": {}, + "previousStartedEventId": { + "type": "long" + } + } + } + }, + "RecordActivityTaskHeartbeat": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "details": {} + } + }, + "output": { + "type": "structure", + "required": [ + "cancelRequested" + ], + "members": { + "cancelRequested": { + "type": "boolean" + } + } + } + }, + "RegisterActivityType": { + "input": { + "type": "structure", + "required": [ + "domain", + "name", + "version" + ], + "members": { + "domain": {}, + "name": {}, + "version": {}, + "description": {}, + "defaultTaskStartToCloseTimeout": {}, + "defaultTaskHeartbeatTimeout": {}, + "defaultTaskList": { + "shape": "Sj" + }, + "defaultTaskScheduleToStartTimeout": {}, + "defaultTaskScheduleToCloseTimeout": {} + } + } + }, + "RegisterDomain": { + "input": { + "type": "structure", + "required": [ + "name", + "workflowExecutionRetentionPeriodInDays" + ], + "members": { + "name": {}, + "description": {}, + "workflowExecutionRetentionPeriodInDays": {} + } + } + }, + "RegisterWorkflowType": { + "input": { + "type": "structure", + "required": [ + "domain", + "name", + "version" + ], + "members": { + "domain": {}, + "name": {}, + "version": {}, + "description": {}, + "defaultTaskStartToCloseTimeout": {}, + "defaultExecutionStartToCloseTimeout": {}, + "defaultTaskList": { + "shape": "Sj" + }, + "defaultChildPolicy": {} + } + } + }, + "RequestCancelWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowId" + ], + "members": { + "domain": {}, + "workflowId": {}, + "runId": {} + } + } + }, + "RespondActivityTaskCanceled": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "details": {} + } + } + }, + "RespondActivityTaskCompleted": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "result": {} + } + } + }, + "RespondActivityTaskFailed": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "reason": {}, + "details": {} + } + } + }, + "RespondDecisionTaskCompleted": { + "input": { + "type": "structure", + "required": [ + "taskToken" + ], + "members": { + "taskToken": {}, + "decisions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "decisionType" + ], + "members": { + "decisionType": {}, + "scheduleActivityTaskDecisionAttributes": { + "type": "structure", + "required": [ + "activityType", + "activityId" + ], + "members": { + "activityType": { + "shape": "Sn" + }, + "activityId": {}, + "control": {}, + "input": {}, + "scheduleToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "scheduleToStartTimeout": {}, + "startToCloseTimeout": {}, + "heartbeatTimeout": {} + } + }, + "requestCancelActivityTaskDecisionAttributes": { + "type": "structure", + "required": [ + "activityId" + ], + "members": { + "activityId": {} + } + }, + "completeWorkflowExecutionDecisionAttributes": { + "type": "structure", + "members": { + "result": {} + } + }, + "failWorkflowExecutionDecisionAttributes": { + "type": "structure", + "members": { + "reason": {}, + "details": {} + } + }, + "cancelWorkflowExecutionDecisionAttributes": { + "type": "structure", + "members": { + "details": {} + } + }, + "continueAsNewWorkflowExecutionDecisionAttributes": { + "type": "structure", + "members": { + "input": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "tagList": { + "shape": "S1a" + }, + "workflowTypeVersion": {} + } + }, + "recordMarkerDecisionAttributes": { + "type": "structure", + "required": [ + "markerName" + ], + "members": { + "markerName": {}, + "details": {} + } + }, + "startTimerDecisionAttributes": { + "type": "structure", + "required": [ + "timerId", + "startToFireTimeout" + ], + "members": { + "timerId": {}, + "control": {}, + "startToFireTimeout": {} + } + }, + "cancelTimerDecisionAttributes": { + "type": "structure", + "required": [ + "timerId" + ], + "members": { + "timerId": {} + } + }, + "signalExternalWorkflowExecutionDecisionAttributes": { + "type": "structure", + "required": [ + "workflowId", + "signalName" + ], + "members": { + "workflowId": {}, + "runId": {}, + "signalName": {}, + "input": {}, + "control": {} + } + }, + "requestCancelExternalWorkflowExecutionDecisionAttributes": { + "type": "structure", + "required": [ + "workflowId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "control": {} + } + }, + "startChildWorkflowExecutionDecisionAttributes": { + "type": "structure", + "required": [ + "workflowType", + "workflowId" + ], + "members": { + "workflowType": { + "shape": "Sr" + }, + "workflowId": {}, + "control": {}, + "input": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "tagList": { + "shape": "S1a" + } + } + } + } + } + }, + "executionContext": {} + } + } + }, + "SignalWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowId", + "signalName" + ], + "members": { + "domain": {}, + "workflowId": {}, + "runId": {}, + "signalName": {}, + "input": {} + } + } + }, + "StartWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowId", + "workflowType" + ], + "members": { + "domain": {}, + "workflowId": {}, + "workflowType": { + "shape": "Sr" + }, + "taskList": { + "shape": "Sj" + }, + "input": {}, + "executionStartToCloseTimeout": {}, + "tagList": { + "shape": "S1a" + }, + "taskStartToCloseTimeout": {}, + "childPolicy": {} + } + }, + "output": { + "type": "structure", + "members": { + "runId": {} + } + } + }, + "TerminateWorkflowExecution": { + "input": { + "type": "structure", + "required": [ + "domain", + "workflowId" + ], + "members": { + "domain": {}, + "workflowId": {}, + "runId": {}, + "reason": {}, + "details": {}, + "childPolicy": {} + } + } + } + }, + "shapes": { + "S3": { + "type": "structure", + "required": [ + "oldestDate" + ], + "members": { + "oldestDate": { + "type": "timestamp" + }, + "latestDate": { + "type": "timestamp" + } + } + }, + "S5": { + "type": "structure", + "required": [ + "workflowId" + ], + "members": { + "workflowId": {} + } + }, + "S7": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {}, + "version": {} + } + }, + "Sa": { + "type": "structure", + "required": [ + "tag" + ], + "members": { + "tag": {} + } + }, + "Sc": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {} + } + }, + "Se": { + "type": "structure", + "required": [ + "count" + ], + "members": { + "count": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + } + } + }, + "Sj": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + }, + "Sk": { + "type": "structure", + "required": [ + "count" + ], + "members": { + "count": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + } + } + }, + "Sn": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": {}, + "version": {} + } + }, + "Sr": { + "type": "structure", + "required": [ + "name", + "version" + ], + "members": { + "name": {}, + "version": {} + } + }, + "Su": { + "type": "structure", + "required": [ + "activityType", + "status", + "creationDate" + ], + "members": { + "activityType": { + "shape": "Sn" + }, + "status": {}, + "description": {}, + "creationDate": { + "type": "timestamp" + }, + "deprecationDate": { + "type": "timestamp" + } + } + }, + "S11": { + "type": "structure", + "required": [ + "name", + "status" + ], + "members": { + "name": {}, + "status": {}, + "description": {} + } + }, + "S15": { + "type": "structure", + "required": [ + "workflowId", + "runId" + ], + "members": { + "workflowId": {}, + "runId": {} + } + }, + "S18": { + "type": "structure", + "required": [ + "execution", + "workflowType", + "startTimestamp", + "executionStatus" + ], + "members": { + "execution": { + "shape": "S15" + }, + "workflowType": { + "shape": "Sr" + }, + "startTimestamp": { + "type": "timestamp" + }, + "closeTimestamp": { + "type": "timestamp" + }, + "executionStatus": {}, + "closeStatus": {}, + "parent": { + "shape": "S15" + }, + "tagList": { + "shape": "S1a" + }, + "cancelRequested": { + "type": "boolean" + } + } + }, + "S1a": { + "type": "list", + "member": {} + }, + "S1k": { + "type": "structure", + "required": [ + "workflowType", + "status", + "creationDate" + ], + "members": { + "workflowType": { + "shape": "Sr" + }, + "status": {}, + "description": {}, + "creationDate": { + "type": "timestamp" + }, + "deprecationDate": { + "type": "timestamp" + } + } + }, + "S1r": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "eventTimestamp", + "eventType", + "eventId" + ], + "members": { + "eventTimestamp": { + "type": "timestamp" + }, + "eventType": {}, + "eventId": { + "type": "long" + }, + "workflowExecutionStartedEventAttributes": { + "type": "structure", + "required": [ + "childPolicy", + "taskList", + "workflowType" + ], + "members": { + "input": {}, + "executionStartToCloseTimeout": {}, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "taskList": { + "shape": "Sj" + }, + "workflowType": { + "shape": "Sr" + }, + "tagList": { + "shape": "S1a" + }, + "continuedExecutionRunId": {}, + "parentWorkflowExecution": { + "shape": "S15" + }, + "parentInitiatedEventId": { + "type": "long" + } + } + }, + "workflowExecutionCompletedEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId" + ], + "members": { + "result": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "completeWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "workflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId" + ], + "members": { + "reason": {}, + "details": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "failWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "workflowExecutionTimedOutEventAttributes": { + "type": "structure", + "required": [ + "timeoutType", + "childPolicy" + ], + "members": { + "timeoutType": {}, + "childPolicy": {} + } + }, + "workflowExecutionCanceledEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId" + ], + "members": { + "details": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "cancelWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "workflowExecutionContinuedAsNewEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId", + "newExecutionRunId", + "taskList", + "childPolicy", + "workflowType" + ], + "members": { + "input": {}, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "newExecutionRunId": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "taskStartToCloseTimeout": {}, + "childPolicy": {}, + "tagList": { + "shape": "S1a" + }, + "workflowType": { + "shape": "Sr" + } + } + }, + "continueAsNewWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "workflowExecutionTerminatedEventAttributes": { + "type": "structure", + "required": [ + "childPolicy" + ], + "members": { + "reason": {}, + "details": {}, + "childPolicy": {}, + "cause": {} + } + }, + "workflowExecutionCancelRequestedEventAttributes": { + "type": "structure", + "members": { + "externalWorkflowExecution": { + "shape": "S15" + }, + "externalInitiatedEventId": { + "type": "long" + }, + "cause": {} + } + }, + "decisionTaskScheduledEventAttributes": { + "type": "structure", + "required": [ + "taskList" + ], + "members": { + "taskList": { + "shape": "Sj" + }, + "startToCloseTimeout": {} + } + }, + "decisionTaskStartedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId" + ], + "members": { + "identity": {}, + "scheduledEventId": { + "type": "long" + } + } + }, + "decisionTaskCompletedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "executionContext": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "decisionTaskTimedOutEventAttributes": { + "type": "structure", + "required": [ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members": { + "timeoutType": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "activityTaskScheduledEventAttributes": { + "type": "structure", + "required": [ + "activityType", + "activityId", + "taskList", + "decisionTaskCompletedEventId" + ], + "members": { + "activityType": { + "shape": "Sn" + }, + "activityId": {}, + "input": {}, + "control": {}, + "scheduleToStartTimeout": {}, + "scheduleToCloseTimeout": {}, + "startToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "heartbeatTimeout": {} + } + }, + "activityTaskStartedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId" + ], + "members": { + "identity": {}, + "scheduledEventId": { + "type": "long" + } + } + }, + "activityTaskCompletedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "result": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "activityTaskFailedEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "reason": {}, + "details": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "activityTaskTimedOutEventAttributes": { + "type": "structure", + "required": [ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members": { + "timeoutType": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + }, + "details": {} + } + }, + "activityTaskCanceledEventAttributes": { + "type": "structure", + "required": [ + "scheduledEventId", + "startedEventId" + ], + "members": { + "details": {}, + "scheduledEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + }, + "latestCancelRequestedEventId": { + "type": "long" + } + } + }, + "activityTaskCancelRequestedEventAttributes": { + "type": "structure", + "required": [ + "decisionTaskCompletedEventId", + "activityId" + ], + "members": { + "decisionTaskCompletedEventId": { + "type": "long" + }, + "activityId": {} + } + }, + "workflowExecutionSignaledEventAttributes": { + "type": "structure", + "required": [ + "signalName" + ], + "members": { + "signalName": {}, + "input": {}, + "externalWorkflowExecution": { + "shape": "S15" + }, + "externalInitiatedEventId": { + "type": "long" + } + } + }, + "markerRecordedEventAttributes": { + "type": "structure", + "required": [ + "markerName", + "decisionTaskCompletedEventId" + ], + "members": { + "markerName": {}, + "details": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "recordMarkerFailedEventAttributes": { + "type": "structure", + "required": [ + "markerName", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "markerName": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "timerStartedEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "startToFireTimeout", + "decisionTaskCompletedEventId" + ], + "members": { + "timerId": {}, + "control": {}, + "startToFireTimeout": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "timerFiredEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "startedEventId" + ], + "members": { + "timerId": {}, + "startedEventId": { + "type": "long" + } + } + }, + "timerCanceledEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "startedEventId", + "decisionTaskCompletedEventId" + ], + "members": { + "timerId": {}, + "startedEventId": { + "type": "long" + }, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "startChildWorkflowExecutionInitiatedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "workflowType", + "taskList", + "decisionTaskCompletedEventId", + "childPolicy" + ], + "members": { + "workflowId": {}, + "workflowType": { + "shape": "Sr" + }, + "control": {}, + "input": {}, + "executionStartToCloseTimeout": {}, + "taskList": { + "shape": "Sj" + }, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "childPolicy": {}, + "taskStartToCloseTimeout": {}, + "tagList": { + "shape": "S1a" + } + } + }, + "childWorkflowExecutionStartedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S15" + }, + "workflowType": { + "shape": "Sr" + }, + "initiatedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionCompletedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S15" + }, + "workflowType": { + "shape": "Sr" + }, + "result": {}, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S15" + }, + "workflowType": { + "shape": "Sr" + }, + "reason": {}, + "details": {}, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionTimedOutEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "timeoutType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S15" + }, + "workflowType": { + "shape": "Sr" + }, + "timeoutType": {}, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionCanceledEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S15" + }, + "workflowType": { + "shape": "Sr" + }, + "details": {}, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "childWorkflowExecutionTerminatedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S15" + }, + "workflowType": { + "shape": "Sr" + }, + "initiatedEventId": { + "type": "long" + }, + "startedEventId": { + "type": "long" + } + } + }, + "signalExternalWorkflowExecutionInitiatedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "signalName", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "signalName": {}, + "input": {}, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "externalWorkflowExecutionSignaledEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "initiatedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S15" + }, + "initiatedEventId": { + "type": "long" + } + } + }, + "signalExternalWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "cause": {}, + "initiatedEventId": { + "type": "long" + }, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "externalWorkflowExecutionCancelRequestedEventAttributes": { + "type": "structure", + "required": [ + "workflowExecution", + "initiatedEventId" + ], + "members": { + "workflowExecution": { + "shape": "S15" + }, + "initiatedEventId": { + "type": "long" + } + } + }, + "requestCancelExternalWorkflowExecutionInitiatedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "requestCancelExternalWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowId": {}, + "runId": {}, + "cause": {}, + "initiatedEventId": { + "type": "long" + }, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + }, + "scheduleActivityTaskFailedEventAttributes": { + "type": "structure", + "required": [ + "activityType", + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "activityType": { + "shape": "Sn" + }, + "activityId": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "requestCancelActivityTaskFailedEventAttributes": { + "type": "structure", + "required": [ + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "activityId": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "startTimerFailedEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "timerId": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "cancelTimerFailedEventAttributes": { + "type": "structure", + "required": [ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members": { + "timerId": {}, + "cause": {}, + "decisionTaskCompletedEventId": { + "type": "long" + } + } + }, + "startChildWorkflowExecutionFailedEventAttributes": { + "type": "structure", + "required": [ + "workflowType", + "cause", + "workflowId", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members": { + "workflowType": { + "shape": "Sr" + }, + "cause": {}, + "workflowId": {}, + "initiatedEventId": { + "type": "long" + }, + "decisionTaskCompletedEventId": { + "type": "long" + }, + "control": {} + } + } + } + } + }, + "S40": { + "type": "structure", + "required": [ + "executionInfos" + ], + "members": { + "executionInfos": { + "type": "list", + "member": { + "shape": "S18" + } + }, + "nextPageToken": {} + } + } + } +} \ No newline at end of file diff --git a/apis/swf-2012-01-25.full.json b/apis/swf-2012-01-25.full.json new file mode 100644 index 0000000000..35a2e4d101 --- /dev/null +++ b/apis/swf-2012-01-25.full.json @@ -0,0 +1,4463 @@ +{ + "metadata":{ + "apiVersion":"2012-01-25", + "endpointPrefix":"swf", + "jsonVersion":"1.0", + "serviceAbbreviation":"Amazon SWF", + "serviceFullName":"Amazon Simple Workflow Service", + "signatureVersion":"v4", + "targetPrefix":"SimpleWorkflowService", + "timestampFormat":"unixTimestamp", + "protocol":"json" + }, + "documentation":"Amazon Simple Workflow Service\n\t\t

\n\t\t\tThe Amazon Simple Workflow Service API Reference is intended for\n\t\t\tprogrammers who need detailed information about the Amazon SWF\n\t\t\tactions and data types.\n\t\t

\n\n\t\t

\n\t\t\tFor an broader overview of the Amazon SWF programming model, please go to the\n\t\t Amazon SWF Developer Guide.\n\t\t

\n\n\t \t

This section provides an overview of Amazon SWF actions.

\n\n \t

Action Categories

\n

The Amazon SWF actions can be grouped into the following major categories.

\t\n \t

Actions related to Activities

\n \t

The following are actions that are performed by activity workers:

\n \t\n \t

Activity workers use the PollForActivityTask to get new activity tasks. After a worker\n \t\treceives an activity task from Amazon SWF, it performs the task and\n \t\tresponds using RespondActivityTaskCompleted\n \t\tif successful or RespondActivityTaskFailed if unsuccessful.\n \t

\n \t

Actions related to Deciders

\n \t

The following are actions that are performed by deciders:

\n \t\n \t

Deciders use PollForDecisionTask to get decision tasks.\n \t\tAfter a decider receives a decision task from Amazon SWF, it examines its workflow execution history and decides what to do next.\n \t\tIt calls\n \t\tRespondDecisionTaskCompletedto\n \t\tcomplete the decision task and provide zero or more next decisions.\n \t

\n \t

Actions related to Workflow Executions

\n \t

The following actions operate on a workflow execution:

\n \t\n \t

Actions related to Administration

\n \t

Although you can perform administrative tasks from the Amazon SWF console, you can use the actions in this section to\n \t\tautomate functions or build your own administrative tools.

\n \t

Activity Management

\n \t\n \t

Workflow Management

\n \t\n\n \t

Domain Management

\n \t\n \t

Workflow Execution Management

\n \t\n\n \t

Visibility Actions

\n \t

Although you can perform visibility actions from the Amazon SWF console, you can use the actions in this section to\n \t\tbuild your own console or administrative tools.

\n \t\n \t

Activity Visibility

\n \t\n\n \t

Workflow Visibility

\n \t\n \t

Workflow Execution Visibility

\n \t\n \t

Domain Visibility

\n \t\n \t

Task List Visibility

\n \t", + "operations":{ + "CountClosedWorkflowExecutions":{ + "name":"CountClosedWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountClosedWorkflowExecutionsInput"}, + "output":{ + "shape":"WorkflowExecutionCount", + "documentation":"

\n\t\tContains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns the number of closed workflow executions within the given domain that meet the specified filtering\n criteria.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails by throwing OperationNotPermitted. For details and example IAM policies, see\n Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n CountClosedWorkflowExecutions Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:42:47 GMT\n X-Amz-Target: SimpleWorkflowService.CountClosedWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=jFS74utjeATV7vj72CWdLToPCKW0RQse6OEDkafB+SA=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 157\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"closeTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"closeStatusFilter\":\n {\"status\": \"TIMED_OUT\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 9bfad387-3f22-11e1-9914-a356b6ea8bdf\n \n {\"count\":3,\"truncated\":false}\n \n \n " + }, + "CountOpenWorkflowExecutions":{ + "name":"CountOpenWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountOpenWorkflowExecutionsInput"}, + "output":{ + "shape":"WorkflowExecutionCount", + "documentation":"

\n\t\tContains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns the number of open workflow executions within the given domain that meet the specified filtering\n criteria.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n CountOpenWorkflowExecutions Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sat, 14 Jan 2012 23:13:29 GMT\n X-Amz-Target: SimpleWorkflowService.CountOpenWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=3v6shiGzWukq4KiX/5HFMIUF/w5qajhW4dp+6AKyOtY=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 150\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"startTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"ricoh-the-dog\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 5ea6789e-3f05-11e1-9e8f-57bb03e21482\n \n {\"count\":1,\"truncated\":false}\n \n \n " + }, + "CountPendingActivityTasks":{ + "name":"CountPendingActivityTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountPendingActivityTasksInput"}, + "output":{ + "shape":"PendingTaskCount", + "documentation":"

\n\t\tContains the count of tasks in a task list.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. \n If you specify a task list that no activity task was ever scheduled in then 0 will be returned.\n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n CountPendingActivityTasks Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:29:28 GMT\n X-Amz-Target: SimpleWorkflowService.CountPendingActivityTasks\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=eCNiyyl5qmP0gGQ0hM8LqeRzxEvVZ0LAjE4oxVzzk9w=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 70\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n }\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 4b977c76-3ff2-11e1-a23a-99d60383ae71\n \n {\"count\":1,\"truncated\":false}\n \n \n \n \n " + }, + "CountPendingDecisionTasks":{ + "name":"CountPendingDecisionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountPendingDecisionTasksInput"}, + "output":{ + "shape":"PendingTaskCount", + "documentation":"

\n\t\tContains the count of tasks in a task list.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. \n If you specify a task list that no decision task was ever scheduled in then 0 will be returned.\n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n \n \n CountPendingDecisionTasks Example \n \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 23:25:57 GMT\n X-Amz-Target: SimpleWorkflowService.CountPendingDecisionTasks\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=i9tUkWnZBLfn/T6BOymajCtwArAll6Stuh1x2C4dbsE=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 70\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n }\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 4718a364-3fd0-11e1-9914-a356b6ea8bdf\n \n {\"count\": 2,\n \"truncated\": false}\n \n \n \n \n " + }, + "DeprecateActivityType":{ + "name":"DeprecateActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateActivityTypeInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"TypeDeprecatedFault", + "exception":true, + "documentation":"

\n\t\tReturned when the specified activity or workflow type was already deprecated.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Deprecates the specified activity type.\n After an activity type has been deprecated, you cannot create new tasks of that activity type.\n Tasks of this type that were scheduled before the type was deprecated will continue to run.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n DeprecateActivityType Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 05:01:06 GMT\n X-Amz-Target: SimpleWorkflowService.DeprecateActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=iX/mNMtNH6IaSNwfZq9hHOhDlLnp7buuj9tO93kRIrQ=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 95\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 191ee17e-3fff-11e1-a23a-99d60383ae71\n \n \n " + }, + "DeprecateDomain":{ + "name":"DeprecateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateDomainInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"DomainDeprecatedFault", + "exception":true, + "documentation":"

\n\t\tReturned when the specified domain has been deprecated.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n\t\t\tDeprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions\n\t\t\tor register new types. However, you can still use visibility actions on this domain.\n\t\t\tDeprecating a domain also deprecates all activity and workflow types registered in the domain.\n\t\t\tExecutions that were started before the domain was deprecated will continue to run.\n\t\t

\n\t\t\n\t\t\tThis operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n\t\t\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\t\t\n\t\t\t \n\t\t\t\t DeprecateDomain Example \n\n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Mon, 16 Jan 2012 05:07:47 GMT\nX-Amz-Target: SimpleWorkflowService.DeprecateDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=BkJDtbH9uZvrarqXTkBEYuYHO7PPygRI8ykV29Dz/5M=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 21\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530901\"}\n \n\n\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 0800c01a-4000-11e1-9914-a356b6ea8bdf\n \n\n \n\t\t" + }, + "DeprecateWorkflowType":{ + "name":"DeprecateWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateWorkflowTypeInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"TypeDeprecatedFault", + "exception":true, + "documentation":"

\n\t\tReturned when the specified activity or workflow type was already deprecated.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions\n of that type. Executions that were started before the type was deprecated will continue to run.\n A deprecated workflow type may still be used when calling visibility actions.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n \n \n DeprecateWorkflowType Example \n \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 05:04:47 GMT\n X-Amz-Target: SimpleWorkflowService.DeprecateWorkflowType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=BGrr1djQvp+YLq3ci2ffpK8KWhZm/PakBL2fFhc3zds=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 102\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 9c8d6d3b-3fff-11e1-9e8f-57bb03e21482\n \n \n \n \n " + }, + "DescribeActivityType":{ + "name":"DescribeActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeActivityTypeInput"}, + "output":{ + "shape":"ActivityTypeDetail", + "documentation":"

\n Detailed information about an activity type.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns information about the specified activity type. This includes\n configuration settings provided at registration time as well as other general information about the type.\n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n DescribeActivityType Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 03:04:10 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=XiGRwOZNLt+ic3VBWvIlRGdcFcRJVSE8J7zyZLU3oXg=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 95\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 387\n Content-Type: application/json\n x-amzn-RequestId: 98d56ff5-3f25-11e1-9b11-7182192d0b57\n \n {\"configuration\":\n {\"defaultTaskHeartbeatTimeout\": \"120\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskScheduleToCloseTimeout\": \"900\",\n \"defaultTaskScheduleToStartTimeout\": \"300\",\n \"defaultTaskStartToCloseTimeout\": \"600\"},\n \"typeInfo\":\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"creationDate\": 1326586446.471,\n \"description\": \"Verify the customer credit\",\n \"status\": \"REGISTERED\"}\n }\n \n \n " + }, + "DescribeDomain":{ + "name":"DescribeDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDomainInput"}, + "output":{ + "shape":"DomainDetail", + "documentation":"

\n\t\tContains details of a domain.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n\t\t\tReturns information about the specified domain including description and status.\n\t

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n\n\t \n\t\t DescribeDomain Example \n\n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sun, 15 Jan 2012 03:13:33 GMT\nX-Amz-Target: SimpleWorkflowService.DescribeDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=IFJtq3M366CHqMlTpyqYqd9z0ChCoKDC5SCJBsLifu4=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 21\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530901\"}\n \n\n\nHTTP/1.1 200 OK\nContent-Length: 137\nContent-Type: application/json\nx-amzn-RequestId: e86a6779-3f26-11e1-9a27-0760db01a4a8\n\n{\"configuration\":\n {\"workflowExecutionRetentionPeriodInDays\": \"60\"},\n \"domainInfo\":\n {\"description\": \"music\",\n \"name\": \"867530901\",\n \"status\": \"REGISTERED\"}\n}\n \n\n \n\n" + }, + "DescribeWorkflowExecution":{ + "name":"DescribeWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkflowExecutionInput"}, + "output":{ + "shape":"WorkflowExecutionDetail", + "documentation":"

\n\t\tContains details about a workflow execution.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns information about the specified workflow execution including its type and some statistics.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n DescribeWorkflowExecution Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:05:18 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=ufQVcSkfUyGPLiS8xbkEBqEc2PmEEE/3Lb9Kr8yozs8=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 127\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"execution\":\n {\"workflowId\": \"20110927-T-1\",\n \"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\"}\n }\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 577\n Content-Type: application/json\n x-amzn-RequestId: 5f85ef79-3f1d-11e1-9e8f-57bb03e21482\n \n {\"executionConfiguration\":\n {\"childPolicy\": \"TERMINATE\",\n \"executionStartToCloseTimeout\": \"3600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"taskStartToCloseTimeout\": \"600\"},\n \"executionInfo\":\n {\"cancelRequested\": false,\n \"execution\":\n {\"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"OPEN\",\n \"startTimestamp\": 1326592619.474,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n \"openCounts\":\n {\"openActivityTasks\": 0,\n \"openChildWorkflowExecutions\": 0,\n \"openDecisionTasks\": 1,\n \"openTimers\": 0}\n }\n \n \n " + }, + "DescribeWorkflowType":{ + "name":"DescribeWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkflowTypeInput"}, + "output":{ + "shape":"WorkflowTypeDetail", + "documentation":"

\n\t\tContains details about a workflow type.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns information about the specified workflow type. This includes\n configuration settings specified when the type was registered and other information\n such as creation date, current status, etc.\n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n DescribeWorkflowType Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 22:40:40 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeWorkflowType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=iGt8t83OmrURqu0pKYbcW6mNdjXbFomevCBPUPQEbaM=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 102\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 348\n Content-Type: application/json\n x-amzn-RequestId: f35a8e7f-3fc9-11e1-a23a-99d60383ae71\n \n {\"configuration\":\n {\"defaultChildPolicy\": \"TERMINATE\",\n \"defaultExecutionStartToCloseTimeout\": \"3600\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskStartToCloseTimeout\": \"600\"},\n \"typeInfo\":\n {\"creationDate\": 1326481174.027,\n \"description\": \"Handle customer orders\",\n \"status\": \"REGISTERED\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n }\n \n \n " + }, + "GetWorkflowExecutionHistory":{ + "name":"GetWorkflowExecutionHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkflowExecutionHistoryInput"}, + "output":{ + "shape":"History", + "documentation":"

\n\t\tPaginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of\n\t\tthe events related to all tasks and events in the life of the workflow execution.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns the history of the specified workflow execution.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n GetWorkflowExecutionHistory Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:44:00 GMT\n X-Amz-Target: SimpleWorkflowService.GetWorkflowExecutionHistory\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=90GENeUWJbEAMWuVI0dcWatHjltMWddXfLjl0MbNOzM=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 175\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"execution\":\n {\"workflowId\": \"20110927-T-1\",\n \"runId\": \"d29e60b5-fa71-4276-a4be-948b0adcd20b\"},\n \"maximumPageSize\": 10,\n \"reverseOrder\": true}\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 2942\n Content-Type: application/json\n x-amzn-RequestId: 5385723f-3ff4-11e1-b118-3bfa5e8e7fc3\n \n {\"events\":\n [\n {\"eventId\": 11,\n \"eventTimestamp\": 1326671603.102,\n \"eventType\": \"WorkflowExecutionTimedOut\",\n \"workflowExecutionTimedOutEventAttributes\":\n {\"childPolicy\": \"TERMINATE\",\n \"timeoutType\": \"START_TO_CLOSE\"}\n },\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 10,\n \"eventTimestamp\": 1326670566.124,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"activityTaskTimedOutEventAttributes\":\n {\"latestHeartbeatRecordedEventId\": 0,\n \"scheduledEventId\": 8,\n \"startedEventId\": 0,\n \"timeoutType\": \"SCHEDULE_TO_START\"},\n \"eventId\": 9,\n \"eventTimestamp\": 1326670566.124,\n \"eventType\": \"ActivityTaskTimedOut\"},\n {\"activityTaskScheduledEventAttributes\":\n {\"activityId\": \"verification-27\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"control\": \"digital music\",\n \"decisionTaskCompletedEventId\": 7,\n \"heartbeatTimeout\": \"120\",\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"scheduleToCloseTimeout\": \"900\",\n \"scheduleToStartTimeout\": \"300\",\n \"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 8,\n \"eventTimestamp\": 1326670266.115,\n \"eventType\": \"ActivityTaskScheduled\"},\n {\"decisionTaskCompletedEventAttributes\":\n {\"executionContext\": \"Black Friday\",\n \"scheduledEventId\": 5,\n \"startedEventId\": 6},\n \"eventId\": 7,\n \"eventTimestamp\": 1326670266.103,\n \"eventType\": \"DecisionTaskCompleted\"},\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 5},\n \"eventId\": 6,\n \"eventTimestamp\": 1326670161.497,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 5,\n \"eventTimestamp\": 1326668752.66,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"decisionTaskTimedOutEventAttributes\":\n {\"scheduledEventId\": 2,\n \"startedEventId\": 3,\n \"timeoutType\": \"START_TO_CLOSE\"},\n \"eventId\": 4,\n \"eventTimestamp\": 1326668752.66,\n \"eventType\": \"DecisionTaskTimedOut\"},\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 2},\n \"eventId\": 3,\n \"eventTimestamp\": 1326668152.648,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 2,\n \"eventTimestamp\": 1326668003.094,\n \"eventType\": \"DecisionTaskScheduled\"}\n ],\n \"nextPageToken\": \"AAAAKgAAAAEAAAAAAAAAATeTvAyvqlQz34ctbGhM5nglWmjzk0hGuHf0g4EO4CblQFku70ukjPgrAHy7Tnp7FaZ0okP8EEWnkfg8gi3Fqy/WVrXyxQaa525D31cIq1owXK21CKR6SQ0Job87G8SHvvqvP7yjLGHlHrRGZUCbJgeEuV4Rp/yW+vKhc8dJ54x7wvpQMwZ+ssG6stTyX26vu1gIDuspk13UrDZa4TbLOFdM0aAocHe3xklKMtD/B4ithem6BWm6CBl/UF7lMfNccwUYEityp1Kht/YrcD9zbJkt1FSt4Y6pgt0njAh4FKRO9nyRyvLmbvgtQXEIQz8hdbjwj3xE1+9ocYwXOCAhVkRsh3OD6F8KHilKfdwg4Xz1jtLXOh4lsCecNb8dS7J9hbRErRbw3rh1Sv415U2Ye23OEfF4Jv7JznpmEyzuq8d2bMyOLjAInQVFK4t1tPo5FAhzdICCXBhRq6Wkt++W9sRQXqqX/HTX5kNomHySZloylPuY5gL5zRj39frInfZk4EXWHwrI+18+erGIHO4nBQpMzO64dMP+A/KtVGCn59rAMmilD6wEE9rH8RuZ03Wkvm9yrJvjrI8/6358n8TMB8OcHoqILkMCAXYiIppnFlm+NWXVqxalHLKOrrNzEZM6qsz3Qj3HV1cpy9P7fnS9QAxrgsAYBoDmdOaFkS3ktAkRa0Sle8STfHi4zKbfIGS7rg==\"}\n \n \n " + }, + "ListActivityTypes":{ + "name":"ListActivityTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListActivityTypesInput"}, + "output":{ + "shape":"ActivityTypeInfos", + "documentation":"

\n\t\tContains a paginated list of activity type information structures.\n

" + }, + "errors":[ + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + }, + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + } + ], + "documentation":"

\n Returns information about all activities registered in the specified domain that match the\n specified name and registration status. The result includes information like creation date, current status of the activity, etc.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n ListActivityTypes Example \n \n {\"domain\": \"867530901\",\n \"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": false}\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 171\n Content-Type: application/json\n x-amzn-RequestId: 11b6fbeb-3f25-11e1-9e8f-57bb03e21482\n \n {\"typeInfos\":\n [\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"creationDate\": 1326586446.471,\n \"description\": \"Verify the customer credit\",\n \"status\": \"REGISTERED\"}\n ]\n }\n \n \n " + }, + "ListClosedWorkflowExecutions":{ + "name":"ListClosedWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClosedWorkflowExecutionsInput"}, + "output":{ + "shape":"WorkflowExecutionInfos", + "documentation":"

\n\t\tContains a paginated list of information about workflow executions.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n ListClosedWorkflowExecutions Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:51:01 GMT\n X-Amz-Target: SimpleWorkflowService.ListClosedWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=WY9jGbf5E3F9smGJHANhEXz9VL+1oGVgNL0/o7cBxQw=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 150\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"closeTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"ricoh-the-dog\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 1084\n Content-Type: application/json\n x-amzn-RequestId: c28b4df4-3f23-11e1-9e8f-57bb03e21482\n \n {\"executionInfos\":\n [\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326590754.654,\n \"execution\":\n {\"runId\": \"c724e07a-b966-441f-a1c0-4831acbda1cd\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326587154.626,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326586831.628,\n \"execution\":\n {\"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326585031.619,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326582914.031,\n \"execution\":\n {\"runId\": \"1e536162-f1ea-48b0-85f3-aade88eef2f7\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326581114.02,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n \n \n " + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsInput"}, + "output":{ + "shape":"DomainInfos", + "documentation":"

\n\t\tContains a paginated collection of DomainInfo structures.\n

" + }, + "errors":[ + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n\t\t\tReturns the list of domains registered in the account.\n\t\t\tThe results may be split into multiple pages.\n\t\t\tTo retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n\t\t

\n\t\t\n\t\t\tThis operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n\t\t\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\n\t \n\t\t ListDomains Example \n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sun, 15 Jan 2012 03:09:58 GMT\nX-Amz-Target: SimpleWorkflowService.ListDomains\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=ZCprC72dUxF9ca3w/tbwKZ8lBQn0jaA4xOJqDF0uqMI=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 86\nPragma: no-cache\nCache-Control: no-cache\n\n{\"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": false}\n \n\n\nHTTP/1.1 200 OK\nContent-Length: 568\nContent-Type: application/json\nx-amzn-RequestId: 67e874cc-3f26-11e1-9b11-7182192d0b57\n\n{\"domainInfos\":\n [\n {\"description\": \"music\",\n \"name\": \"867530901\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"music\",\n \"name\": \"867530902\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"Demo\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"DemoDomain\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"Samples\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain2\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain3\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain4\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"zsxfvgsxcv\",\n \"status\": \"REGISTERED\"}\n ]\n}\n \n \n " + }, + "ListOpenWorkflowExecutions":{ + "name":"ListOpenWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOpenWorkflowExecutionsInput"}, + "output":{ + "shape":"WorkflowExecutionInfos", + "documentation":"

\n\t\tContains a paginated list of information about workflow executions.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Returns a list of open workflow executions in the specified domain that meet the filtering criteria.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n ListOpenWorkflowExecutions \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sat, 14 Jan 2012 23:51:04 GMT\n X-Amz-Target: SimpleWorkflowService.ListOpenWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=4kUhpZUp37PgpeOKHlWTsZi+Pq3Egw4mTkPNiEUgp28=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 151\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"startTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"music purchase\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 313\n Content-Type: application/json\n x-amzn-RequestId: 9efeff4b-3f0a-11e1-9e8f-57bb03e21482\n \n {\"executionInfos\":\n [\n {\"cancelRequested\": false,\n \"execution\":\n {\"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"OPEN\",\n \"startTimestamp\": 1326585031.619,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n \n \n " + }, + "ListWorkflowTypes":{ + "name":"ListWorkflowTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkflowTypesInput"}, + "output":{ + "shape":"WorkflowTypeInfos", + "documentation":"

\n\t\tContains a paginated list of information structures about workflow types.\n

" + }, + "errors":[ + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + }, + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + } + ], + "documentation":"

\n Returns information about workflow types in the specified domain. The results may be split into multiple\n pages that can be retrieved by making the call repeatedly.\n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n ListWorkflowTypes Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 22:25:43 GMT\n X-Amz-Target: SimpleWorkflowService.ListWorkflowTypes\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=uleWQSyVVf0+aG50IoBJG5h0hzxNFNT97Mkn/FSCQ+Q=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 110\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": true}\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 174\n Content-Type: application/json\n x-amzn-RequestId: dcde6719-3fc7-11e1-9e8f-57bb03e21482\n \n {\"typeInfos\":\n [\n {\"creationDate\": 1326481174.027,\n \"description\": \"Handle customer orders\",\n \"status\": \"REGISTERED\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n \n \n " + }, + "PollForActivityTask":{ + "name":"PollForActivityTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PollForActivityTaskInput"}, + "output":{ + "shape":"ActivityTask", + "documentation":"

\n Unit of work sent to an activity worker.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + }, + { + "shape":"LimitExceededFault", + "exception":true, + "documentation":"

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

" + } + ], + "documentation":"

\n Used by workers to get an ActivityTask from the specified activity taskList.\n This initiates a long poll, where the service holds the HTTP\n connection open and responds as soon as a task becomes available.\n The maximum time the service holds on to the request before responding is 60 seconds. If no task is\n available within 60 seconds, the poll will return an empty result.\n An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string.\n If a task is returned, the worker should use its type to identify and process it correctly.\n

\n \n Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n PollForActivityTask Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:53:52 GMT\n X-Amz-Target: SimpleWorkflowService.PollForActivityTask\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=dv0H1RPYucoIcRckspWO0f8xG120MWZRKmj3O5/A4rY=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 108\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"mainTaskList\"},\n \"identity\": \"VerifyCreditCardWorker01\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 837\n Content-Type: application/json\n x-amzn-RequestId: b48fb6b5-3ff5-11e1-a23a-99d60383ae71\n \n {\"activityId\": \"verification-27\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"startedEventId\": 11,\n \"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"workflowExecution\":\n {\"runId\": \"cfa2bd33-31b0-4b75-b131-255bb0d97b3f\",\n \"workflowId\": \"20110927-T-1\"}\n }\n \n \n " + }, + "PollForDecisionTask":{ + "name":"PollForDecisionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PollForDecisionTaskInput"}, + "output":{ + "shape":"DecisionTask", + "documentation":"

\n\t\tA structure that represents a decision task. Decision tasks are sent to\n\t\tdeciders in order for them to make decisions.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + }, + { + "shape":"LimitExceededFault", + "exception":true, + "documentation":"

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

" + } + ], + "documentation":"

\n Used by deciders to get a DecisionTask from the specified decision taskList.\n A decision task may be returned for any open workflow execution that is\n using the specified task list. The task includes a paginated view of the history of the workflow execution.\n The decider should use the workflow type and the history to determine how to properly handle the task.\n

\n

\n This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available.\n If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned.\n An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.\n

\n \n Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).\n \n \n Because the number of workflow history events for a single workflow execution might be very large, the result\n returned might be split up across a number of pages.\n To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call.\n Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n \n \n PollForDecisionTask Example \n \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:09:54 GMT\n X-Amz-Target: SimpleWorkflowService.PollForDecisionTask\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=R3CJ2HMLSVpc2p6eafeztZCZWcgza+h61gSUuWx15gw=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 171\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"identity\": \"Decider01\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": true}\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 1639\n Content-Type: application/json\n x-amzn-RequestId: 03db54cf-3f1e-11e1-b118-3bfa5e8e7fc3\n \n {\"events\":\n [\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 2},\n \"eventId\": 3,\n \"eventTimestamp\": 1326593394.566,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 2,\n \"eventTimestamp\": 1326592619.474,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"eventId\": 1,\n \"eventTimestamp\": 1326592619.474,\n \"eventType\": \"WorkflowExecutionStarted\",\n \"workflowExecutionStartedEventAttributes\":\n {\"childPolicy\": \"TERMINATE\",\n \"executionStartToCloseTimeout\": \"3600\",\n \"input\": \"arbitrary-string-that-is-meaningful-to-the-workflow\",\n \"parentInitiatedEventId\": 0,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"taskStartToCloseTimeout\": \"600\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n }\n ],\n \"previousStartedEventId\": 0,\n \"startedEventId\": 3,\n \"taskToken\": \"AAAAKgAAAAEAAAAAAAAAATZDvCYwk/hP/X1ZGdJhb+T6OWzcBx2DPhsIi5HF4aGQI4OXrDE7Ny3uM+aiAhGrmeNyVAa4yNIBQuoZuJA5G+BoaB0JuHFBOynHDTnm7ayNH43KhMkfdrDG4elfHSz3m/EtbLnFGueAr7+3NKDG6x4sTKg3cZpOtSguSx05yI1X3AtscS8ATcLB2Y3Aub1YonN/i/k67voca/GFsSiwSz3AAnJj1IPvrujgIj9KUvckwRPC5ET7d33XJcRp+gHYzZsBLVBaRmV3gEYAnp2ICslFn4YSjGy+dFXCNpOa4G1O8pczCbFUGbQ3+5wf0RSaa/xMq2pfdBKnuFp0wp8kw1k+5ZsbtDZeZn8g5GyKCLiLms/xD0OxugGGUe5ZlAoHEkTWGxZj/G32P7cMoCgrcACfFPdx1LNYYEre7YiGiyjGnfW2t5mW7VK9Np28vcXVbdpH4JNEB9OuB1xqL8N8ifPVtc72uxB1i9XEdq/8rkXasSEw4TubB2FwgqnuJstmfEhpOdb5HfhR6OwmnHuk9eszO/fUkGucTUXQP2hhB+Gz\",\n \"workflowExecution\":\n {\"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\",\n \"workflowId\": \"20110927-T-1\"},\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n \n \n \n \n " + }, + "RecordActivityTaskHeartbeat":{ + "name":"RecordActivityTaskHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RecordActivityTaskHeartbeatInput"}, + "output":{ + "shape":"ActivityTaskStatus", + "documentation":"

\n Status information about an activity task.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Used by activity workers to report to the service that the ActivityTask represented by the specified\n taskToken is still making progress. The worker can also (optionally) specify details of the progress,\n for example percent complete, using the details parameter.\n \n This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task.\n If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag\n returned by the service is set to true.\n

\n

\n This action resets the taskHeartbeatTimeout clock.\n The taskHeartbeatTimeout is specified in RegisterActivityType.\n

\n

\n This action does not in itself create an event in the workflow execution history.\n However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event\n that contains the information from the last heartbeat generated by the activity worker.\n

\n \n The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless\n of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also\n specified in RegisterActivityType.\n \n \n This operation is only useful for long-lived activities to report liveliness of the task and to determine\n if a cancellation is being attempted.\n \n \n \n If the cancelRequested flag returns true, a cancellation is being\n attempted. If the worker can cancel the activity, it should respond with\n RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n RecordActivityTaskHeartbeat Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:55:06 GMT\n X-Amz-Target: SimpleWorkflowService.RecordActivityTaskHeartbeat\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=DEA8rw5TqtpqCeTljl7eotZkuWTgmGZ1PWyDNZPehT0=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 623\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"details\": \"starting task\"}\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 25\n Content-Type: application/json\n x-amzn-RequestId: e08622cd-3ff5-11e1-9b11-7182192d0b57\n \n {\"cancelRequested\":false}\n \n \n " + }, + "RegisterActivityType":{ + "name":"RegisterActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterActivityTypeInput"}, + "errors":[ + { + "shape":"TypeAlreadyExistsFault", + "exception":true, + "documentation":"

\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n

" + }, + { + "shape":"LimitExceededFault", + "exception":true, + "documentation":"

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

" + }, + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Registers a new activity type along with its configuration settings in the specified domain.\n

\n \n \n A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration\n settings of the type after its registration, and it must be registered as a new version.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n RegisterActivityType Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 00:14:06 GMT\n X-Amz-Target: SimpleWorkflowService.RegisterActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=F9cptqaGWa2H7LW3dpctF9J5svsB6FRZ4krghCRnml0=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 343\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"name\": \"activityVerify\",\n \"version\": \"1.0\",\n \"description\": \"Verify the customer credit card\",\n \"defaultTaskStartToCloseTimeout\": \"600\",\n \"defaultTaskHeartbeatTimeout\": \"120\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskScheduleToStartTimeout\": \"300\",\n \"defaultTaskScheduleToCloseTimeout\": \"900\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: d68969c7-3f0d-11e1-9b11-7182192d0b57\n \n \n " + }, + "RegisterDomain":{ + "name":"RegisterDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterDomainInput"}, + "errors":[ + { + "shape":"DomainAlreadyExistsFault", + "exception":true, + "documentation":"

\n Returned if the specified domain already exists. You will\n get this fault even if the existing domain is in deprecated status.\n

" + }, + { + "shape":"LimitExceededFault", + "exception":true, + "documentation":"

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n\t\t\tRegisters a new domain.\n\t\t

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n

\n\n\t \n\t\t RegisterDomain Example \n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Fri, 13 Jan 2012 18:42:12 GMT\nX-Amz-Target: SimpleWorkflowService.RegisterDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=tzjkF55lxAxPhzp/BRGFYQRQRq6CqrM254dTDE/EncI=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 91\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530902\",\n \"description\": \"music\",\n \"workflowExecutionRetentionPeriodInDays\": \"60\"}\n \n\n\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 4ec4ac3f-3e16-11e1-9b11-7182192d0b57\n \n\n \n\n " + }, + "RegisterWorkflowType":{ + "name":"RegisterWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterWorkflowTypeInput"}, + "errors":[ + { + "shape":"TypeAlreadyExistsFault", + "exception":true, + "documentation":"

\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n

" + }, + { + "shape":"LimitExceededFault", + "exception":true, + "documentation":"

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

" + }, + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n\t\t\tRegisters a new workflow type and its configuration settings in the specified domain. \n\t\t

\n

\n The retention period for the workflow history is set by the RegisterDomain action.\n

\n\t\t\n\t\t\tIf the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings\n\t\t\tof a workflow type once it is registered and it must be registered as a new version.\n\t\t\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\n\n\t \n\t\t RegisterWorkflowType Example \n\n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Fri, 13 Jan 2012 18:59:33 GMT\nX-Amz-Target: SimpleWorkflowService.RegisterWorkflowType\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=p5FUOoV3QXAafb7aK5z79Ztu5v0w9NeEqLu0ei+P9FA=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 300\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\",\n \"description\": \"Handle customer orders\",\n \"defaultTaskStartToCloseTimeout\": \"600\",\n \"defaultExecutionStartToCloseTimeout\": \"3600\",\n \"defaultTaskList\":\n\t{\"name\": \"mainTaskList\"},\n \"defaultChildPolicy\": \"TERMINATE\"}\n \n\n\n\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: bb469e67-3e18-11e1-9914-a356b6ea8bdf\n \n\n \n " + }, + "RequestCancelWorkflowExecution":{ + "name":"RequestCancelWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestCancelWorkflowExecutionInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Records a WorkflowExecutionCancelRequested event in the currently running workflow execution\n identified by the given domain, workflowId, and runId. This logically requests the\n cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n

\n \n If the runId is not specified, the\n WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the\n specified workflowId in the domain.\n \n \n Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of\n TerminateWorkflowExecution when possible.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n RequestCancelWorkflowExecution Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:49:06 GMT\n X-Amz-Target: SimpleWorkflowService.RequestCancelWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=xODwV3kbpJbWVa6bQiV2zQAw9euGI3uXI82urc+bVeo=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 106\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"94861fda-a714-4126-95d7-55ba847da8ab\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 6bd0627e-3ffd-11e1-9b11-7182192d0b57\n \n \n " + }, + "RespondActivityTaskCanceled":{ + "name":"RespondActivityTaskCanceled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskCanceledInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Used by workers to tell the service that the ActivityTask identified by the taskToken\n was successfully canceled. Additional details can be optionally provided using the details argument.\n

\n

\n These details (if provided) appear in the ActivityTaskCanceled event added to\n the workflow history.\n

\n \n Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns\n true and if the activity can be safely undone or abandoned.\n \n \n

\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to \n RespondActivityTaskCompleted, RespondActivityTaskCanceled, \n RespondActivityTaskFailed, or the task has \n timed out. \n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n RespondActivityTaskCanceled Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:36:44 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskCanceled\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=7ZMb0Np0OyXw6hrFSBFDAfBnSaEP1TH7cAG29DL5BUI=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 640\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAQlFok8Ay875ki85gos/Okm9kWg1Jm6DbwiBZgxyCrW2OS+DQQtrCTMr+KH1ouxrCVOkTXPOUY/M4Ujfr1CrsMi6S0DMD8/N6yxzd34+PIIvRY8w9M5z89PbPQKjKHKbz2ocbTnHgRThaBO4ZmeadNyZWSeQyZXmsQFmFuHfaH9P2ibzrDS1dU+s/iw/R9RBrRWArsph/FIfWdRUJfu/FH9IFPSb3KYKMVaJAOyWhcR1KrRGywIGxPC7m9tQjapXqitoRYj42qgABydT4NVR5cLCkeYW0LKxUGVU46+gNvRaUfYzP31JVARQh5d0j7S/ERi10m6bamPJ3UcZfLFbM42mIINywmcTORMpQ/nPGLU1iECYrtnAV0YTlGZfGm+Vi6Gcgwyi4hEjg7TCBjc6WBw3JuAfFvUPU5cfvAoX7quUZRA7JUnYGObE0y9zYuTnCx6C1GL7Ks2MEA0coIiAl4JZx6qsGYfeKjIGntTsoCEe1zjp5gRqfeD74kfeZg0HmqA0xiFGZ40OHbImnF5YHsedYfLk6u09SAkQMD8iJhT8\",\n \"details\": \"customer canceled transaction\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: b1a001a6-3ffb-11e1-9b11-7182192d0b57\n \n \n " + }, + "RespondActivityTaskCompleted":{ + "name":"RespondActivityTaskCompleted", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskCompletedInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Used by workers to tell the service that the ActivityTask identified by the taskToken\n completed successfully with a result (if provided).\n The result appears in the ActivityTaskCompleted event in the workflow\n history.\n

\n \n \n If the requested task does not complete successfully, use RespondActivityTaskFailed instead.\n If the worker finds that the task is canceled through the canceled flag returned by\n RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.\n \n \n

\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to \n RespondActivityTaskCompleted, RespondActivityTaskCanceled, \n RespondActivityTaskFailed, or the task has \n timed out. \n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n RespondActivityTaskCompleted Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:56:15 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskCompleted\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=M+ygHbMHSHJiVrsAQTW/BfkgHoNzLPnPD+dVywJiPXE=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 638\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"result\": \"customer credit card verified\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 0976f0f4-3ff6-11e1-9a27-0760db01a4a8\n \n \n " + }, + "RespondActivityTaskFailed":{ + "name":"RespondActivityTaskFailed", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskFailedInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Used by workers to tell the service that the ActivityTask identified by the taskToken\n has failed with reason (if specified).\n The reason and details appear in the\n ActivityTaskFailed event added to the workflow history.\n

\n \n

\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to \n RespondActivityTaskCompleted, RespondActivityTaskCanceled, \n RespondActivityTaskFailed, or the task has \n timed out. \n

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n RespondActivityTaskFailed Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:17:24 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskFailed\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=JC+/uds/mFEq8qca2WFs5kfp2eAEONc70IqFgHErhpc=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 682\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAdG7j7YFEl9pfKdXRL3Cy3Q3c1Z8QwdOSX53bKiUV6MMGXvf3Lrinmmzj1HFFl5lcwHzEFxLbMaSZ/lMt/RFJPumHXAnUqlYjZLODhrBqsIzDQFKcbCFMq7y4jm0EFzsV2Suv8iu/obcZ/idU8qjd9uG/82zumG2xz1Z4IbOFwOTlpj2++5YVH4ftyycIcjlDw58r0O1vAo4PEondkqjyn+YxBxyZLy1z1fvMi0zeO8Lh16w96y6v+KdVc/ECoez1Og8sROaXG0l8ptW5YR733LIuUBK4sxWa12egF5i4e8AV8JloojOaq0jy4iFsIscRazOSQErjo15Guz89BK2XW911P3I+X7nJjH0wwW55XGCs0jezvsEC8M6D9Ob7CgWr6RrnK3g1AKemcby2XqgQRN52DMIYxzV+lMS/QBYKOqtkLoMY0NKeuRVwm9f1zCY00v6kxqK9m2zFvaxqlJ5/JVCWMNWEWJfQZVtC3GzMWmzeCt7Auq8A5/Caq/DKyOhTIhY/Go00iiDA6ecP8taTYiVzb8VR5xEiQ1uCxnECkwW\",\n \"reason\": \"could not verify customer credit card\",\n \"details\": \"card number invalid\"}\n \n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: feadaedd-3ff8-11e1-9e8f-57bb03e21482\n \n \n " + }, + "RespondDecisionTaskCompleted":{ + "name":"RespondDecisionTaskCompleted", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondDecisionTaskCompletedInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Used by deciders to tell the service that the DecisionTask identified by the taskToken\n has successfully completed. The decisions argument specifies the list of decisions made while\n processing the task.\n

\n

\n A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is\n attached to the event in the workflow execution history.\n

\n \n

Access Control

\n

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the\n list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies\n to be as readable as possible, you can express permissions on decisions as if they were actual API\n calls, including applying conditions to some parameters. For more information,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n RespondDecisionTaskCompleted Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 23:31:06 GMT\n X-Amz-Target: SimpleWorkflowService.RespondDecisionTaskCompleted\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=FL4ouCb8n6j5egcKOXoa+5Vctc8WmA91B2ekKnks2J8=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 1184\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAQLPoqDSLcx4ksNCEQZCyEBqpKhE+FgFSOvHd9zlCROacKYHh640MkANx2y9YM3CQnec0kEb1oRvB6DxKesTY3U/UQhvBqPY7E4BYE6hkDj/NmSbt9EwEJ/a+WD+oc2sDNfeVz2x+6wjb5vQdFKwBoQ6MDWLFbAhcgK+ymoRjoBHrPsrNLX3IA6sQaPmQRZQs3FRZonoVzP6uXMCZPnCZQULFjU1kTM8VHzH7ywqWKVmmdvnqyREOCT9VqmYbhLntJXsDj+scAvuNy17MCX9M9AJ7V/5qrLCeYdWA4FBQgY4Ew6IC+dge/UZdVMmpW/uB7nvSk6owQIhapPh5pEUwwY/yNnoVLTiPOz9KzZlANyw7uDchBRLvUJORFtpP9ZQIouNP8QOvFWm7Idc50ahwGEdTCiG+KDXV8kAzx7wKHs7l1TXYkC15x0h3XPH0MdLeEjipv98EpZaMIVtgGSdRjluOjNWEL2zowZByitleI5bdvxZdgalAXXKEnbYE6/rfLGReAJKdh2n0dmTMI+tK7uuxIWX6F4ocqSI1Xb2x5zZ\",\n \"decisions\":\n [\n {\"decisionType\": \"ScheduleActivityTask\",\n \"scheduleActivityTaskDecisionAttributes\":\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"activityId\": \"verification-27\",\n \"control\": \"digital music\",\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"scheduleToCloseTimeout\": \"900\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"scheduleToStartTimeout\": \"300\",\n \"startToCloseTimeout\": \"600\",\n \"heartbeatTimeout\": \"120\"}\n }\n ],\n \"executionContext\": \"Black Friday\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: feef79b5-3fd0-11e1-9a27-0760db01a4a8\n \n \n " + }, + "SignalWorkflowExecution":{ + "name":"SignalWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SignalWorkflowExecutionInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n Records a WorkflowExecutionSignaled event in the workflow execution history and creates\n a decision task for the workflow execution\n identified by the given domain, workflowId and runId. The event is recorded with the\n specified user defined signalName and input (if provided).\n

\n \n If a runId is not specified, then the WorkflowExecutionSignaled\n event is recorded in the history of the current open workflow with the matching workflowId in the domain.\n \n \n If the specified workflow execution is not open, this method fails\n with UnknownResource.\n \n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n \n \n SignalWorkflowExecution Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 00:06:18 GMT\n X-Amz-Target: SimpleWorkflowService.SignalWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=lQpBZezK7JNQrXeWuJE+l7S0ZwjOEONCeRyImoyfX+E=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 162\n Pragma: no-cache\n Cache-Control: no-cache\n \n {\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"signalName\": \"CancelOrder\",\n \"input\": \"order 3553\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: bf78ae15-3f0c-11e1-9914-a356b6ea8bdf\n \n \n " + }, + "StartWorkflowExecution":{ + "name":"StartWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartWorkflowExecutionInput"}, + "output":{ + "shape":"Run", + "documentation":"

\n Specifies the runId of a workflow execution.\n

" + }, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"TypeDeprecatedFault", + "exception":true, + "documentation":"

\n\t\tReturned when the specified activity or workflow type was already deprecated.\n

" + }, + { + "shape":"WorkflowExecutionAlreadyStartedFault", + "exception":true, + "documentation":"

\n \t\tReturned by StartWorkflowExecution when an open execution with the same\n \t\tworkflowId is already running in the specified domain.\n

" + }, + { + "shape":"LimitExceededFault", + "exception":true, + "documentation":"

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + }, + { + "shape":"DefaultUndefinedFault", + "exception":true + } + ], + "documentation":"

\n\t\t\tStarts an execution of the workflow type in the specified domain using the provided workflowId\n\t\t\tand input data.\n\t\t

\n\t\t

This action returns the newly started workflow execution.

\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\n\t \n\t\t StartWorkflowExecution Example \n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sat, 14 Jan 2012 22:45:13 GMT\nX-Amz-Target: SimpleWorkflowService.StartWorkflowExecution\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=aYxuqLX+TO91kPVg+jh+aA8PWxQazQRN2+SZUGdOgU0=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 417\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"},\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"input\": \"arbitrary-string-that-is-meaningful-to-the-workflow\",\n \"executionStartToCloseTimeout\": \"1800\",\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"taskStartToCloseTimeout\": \"600\",\n \"childPolicy\": \"TERMINATE\"}\n \n\n\nHTTP/1.1 200 OK\nContent-Length: 48\nContent-Type: application/json\nx-amzn-RequestId: 6c25f6e6-3f01-11e1-9a27-0760db01a4a8\n\n{\"runId\":\"1e536162-f1ea-48b0-85f3-aade88eef2f7\"}\n \n \n " + }, + "TerminateWorkflowExecution":{ + "name":"TerminateWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateWorkflowExecutionInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + { + "shape":"OperationNotPermittedFault", + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + } + ], + "documentation":"

\n\t\t\tRecords a WorkflowExecutionTerminated event and forces closure of the\n\t\t\tworkflow execution identified by the given domain, runId, and workflowId.\n\t\t\tThe child policy, registered with the workflow type or specified when starting this execution,\n\t\t\tis applied to any open child workflow executions of this\n\t\t\tworkflow execution.\n\t\t

\n\t\t\n\t\t\tIf the identified workflow execution was in progress, it is terminated immediately.\n\t\t\n\t\t\n\t\t\tIf a runId is not specified, then the WorkflowExecutionTerminated\n\t\t\tevent is recorded in the history of the current open workflow with the matching workflowId in the domain.\n\t\t\n\t\t\n\t\t\tYou should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while\n\t\t\tTerminateWorkflowExecution does not.\n\t\n \n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n\n\t \n\t\t TerminateWorkflowExecution Example \n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Mon, 16 Jan 2012 04:56:34 GMT\nX-Amz-Target: SimpleWorkflowService.TerminateWorkflowExecution\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=JHMRAjN6JGPawEuhiANHfiCil9KOGfDF/cuXYmuu9S4=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 218\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"94861fda-a714-4126-95d7-55ba847da8ab\",\n \"reason\": \"transaction canceled\",\n \"details\": \"customer credit card declined\",\n \"childPolicy\": \"TERMINATE\"}\n \n\n\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 76d68a47-3ffe-11e1-b118-3bfa5e8e7fc3\n \n \n " + } + }, + "shapes":{ + "ActivityId":{ + "type":"string", + "min":1, + "max":256 + }, + "ActivityTask":{ + "type":"structure", + "required":[ + "taskToken", + "activityId", + "startedEventId", + "workflowExecution", + "activityType" + ], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

\n The opaque string used as a handle on the task. This token is used by workers to\n communicate progress and response information back to the system about\n the task.\n

" + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

\n The unique ID of the task.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the ActivityTaskStarted event recorded in the history.\n

" + }, + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The workflow execution that started this activity task.\n

" + }, + "activityType":{ + "shape":"ActivityType", + "documentation":"

\n The type of this activity task.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n The inputs provided when the activity task was scheduled. The form of the input is\n user defined and should be meaningful to the activity implementation.\n

" + } + }, + "documentation":"

\n Unit of work sent to an activity worker.\n

" + }, + "ActivityTaskCancelRequestedEventAttributes":{ + "type":"structure", + "required":[ + "decisionTaskCompletedEventId", + "activityId" + ], + "members":{ + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelActivityTask decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

\n The unique ID of the task.\n

" + } + }, + "documentation":"

\n Provides details of the ActivityTaskCancelRequested event.\n

" + }, + "ActivityTaskCanceledEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "details":{ + "shape":"Data", + "documentation":"

\n Details of the cancellation (if any).\n

" + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "latestCancelRequestedEventId":{ + "shape":"EventId", + "documentation":"

\n If set, contains the Id of the last ActivityTaskCancelRequested event recorded for this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ActivityTaskCanceled event.\n

" + }, + "ActivityTaskCompletedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "result":{ + "shape":"Data", + "documentation":"

\n The results of the activity task (if any).\n

" + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ActivityTaskCompleted event.\n

" + }, + "ActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "reason":{ + "shape":"FailureReason", + "documentation":"

\n The reason provided for the failure (if any).\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n The details of the failure (if any).\n

" + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ActivityTaskFailed event.\n

" + }, + "ActivityTaskScheduledEventAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId", + "taskList", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityType":{ + "shape":"ActivityType", + "documentation":"

\n The type of the activity task.\n

" + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

\n The unique id of the activity task.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n The input provided to the activity task.\n

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n

" + }, + "scheduleToStartTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n The maximum amount of time the activity task can wait to be assigned to a worker.\n

" + }, + "scheduleToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n The maximum amount of time for this activity task.\n

" + }, + "startToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n The maximum amount of time a worker may take to process the activity task.\n

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n The task list in which the activity task has been scheduled.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "heartbeatTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n The maximum time before which the worker processing this task must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.\n

" + } + }, + "documentation":"

\n Provides details of the ActivityTaskScheduled event.\n

" + }, + "ActivityTaskStartedEventAttributes":{ + "type":"structure", + "required":["scheduledEventId"], + "members":{ + "identity":{ + "shape":"Identity", + "documentation":"

\n Identity of the worker that was assigned this task. This aids diagnostics\n when problems arise. The form of this identity is user defined.\n

" + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ActivityTaskStarted event.\n

" + }, + "ActivityTaskStatus":{ + "type":"structure", + "required":["cancelRequested"], + "members":{ + "cancelRequested":{ + "shape":"Canceled", + "documentation":"

\n Set to true if cancellation of the task is requested.\n

" + } + }, + "documentation":"

\n Status information about an activity task.\n

" + }, + "ActivityTaskTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members":{ + "timeoutType":{ + "shape":"ActivityTaskTimeoutType", + "documentation":"

\n The type of the timeout that caused this event.\n

" + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "details":{ + "shape":"LimitedData", + "documentation":"

\n Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.\n

" + } + }, + "documentation":"

\n Provides details of the ActivityTaskTimedOut event.\n

" + }, + "ActivityTaskTimeoutType":{ + "type":"string", + "enum":[ + "START_TO_CLOSE", + "SCHEDULE_TO_START", + "SCHEDULE_TO_CLOSE", + "HEARTBEAT" + ] + }, + "ActivityType":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

" + }, + "version":{ + "shape":"Version", + "documentation":"

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

" + } + }, + "documentation":"

\n Represents an activity type.\n

" + }, + "ActivityTypeConfiguration":{ + "type":"structure", + "members":{ + "defaultTaskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tThe optional default maximum duration for tasks of an activity type specified when\n\t\t\tregistering the activity type. You can\n\t\t\toverride this default when scheduling a task through the ScheduleActivityTask Decision.\n\t\t

\n\t\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultTaskHeartbeatTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tThe optional default maximum time, specified when registering the activity type,\n\t\t\tbefore which a worker processing a task must report progress by\n\t\t\tcalling RecordActivityTaskHeartbeat.\n\t\t\tYou can override this default when scheduling a task through the ScheduleActivityTask Decision.\n\t\t\tIf the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker\n\t\t\treceives an UnknownResource fault.\n\t\t\tIn this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.\n\t\t

\n\t\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultTaskList":{ + "shape":"TaskList", + "documentation":"

\n\t\t\tThe optional default task list specified for this activity type at registration. This default task list is used\n\t\t\tif a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision.\n\t\t\tYou can override this default when scheduling a task through the ScheduleActivityTask Decision.\n\t \t

" + }, + "defaultTaskScheduleToStartTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tThe optional default maximum duration, specified when registering the activity type,\n\t\t\tthat a task of an activity type can wait before being assigned to a worker.\n\t\t\tYou can override this default when scheduling a task through the ScheduleActivityTask Decision.\n\t\t

\n\t\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultTaskScheduleToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tThe optional default maximum duration, specified when registering the activity type,\n\t\t\tfor tasks of this activity type.\n\t\t\tYou can override this default when scheduling a task through the ScheduleActivityTask Decision.\n\t\t

\n\t\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + } + }, + "documentation":"

\n\t\t\tConfiguration settings registered with the activity type.\n\t\t

" + }, + "ActivityTypeDetail":{ + "type":"structure", + "required":[ + "typeInfo", + "configuration" + ], + "members":{ + "typeInfo":{ + "shape":"ActivityTypeInfo", + "documentation":"

\n General information about the activity type.\n

\n

\n The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.\n

\n " + }, + "configuration":{ + "shape":"ActivityTypeConfiguration", + "documentation":"

\n The configuration settings registered with the activity type.\n

" + } + }, + "documentation":"

\n Detailed information about an activity type.\n

" + }, + "ActivityTypeInfo":{ + "type":"structure", + "required":[ + "activityType", + "status", + "creationDate" + ], + "members":{ + "activityType":{ + "shape":"ActivityType", + "documentation":"

\n\t\t\tThe ActivityType type structure representing the activity type.\n\t\t

" + }, + "status":{ + "shape":"RegistrationStatus", + "documentation":"

\n\t\t\tThe current status of the activity type.\n\t\t

" + }, + "description":{ + "shape":"Description", + "documentation":"

\n\t\t\tThe description of the activity type provided in RegisterActivityType.\n\t\t

" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

\n\t\t\tThe date and time this activity type was created through RegisterActivityType.\n\t \t

" + }, + "deprecationDate":{ + "shape":"Timestamp", + "documentation":"

\n\t\t\tIf DEPRECATED, the date and time DeprecateActivityType was called.\n\t\t

" + } + }, + "documentation":"

\n\t\t\tDetailed information about an activity type.\n\t\t

" + }, + "ActivityTypeInfoList":{ + "type":"list", + "member":{"shape":"ActivityTypeInfo"} + }, + "ActivityTypeInfos":{ + "type":"structure", + "required":["typeInfos"], + "members":{ + "typeInfos":{ + "shape":"ActivityTypeInfoList", + "documentation":"

\n\t\tList of activity type information.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n\t \tReturns a value if the results are paginated. To get the next page of results, repeat the request\n\t \tspecifying this token and all other arguments unchanged.\n

" + } + }, + "documentation":"

\n\t\tContains a paginated list of activity type information structures.\n

" + }, + "CancelTimerDecisionAttributes":{ + "type":"structure", + "required":["timerId"], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

\n\t\tThe unique Id of the timer to cancel. This field is required.\n

" + } + }, + "documentation":"

Provides details of the CancelTimer decision.

\n\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "CancelTimerFailedCause":{ + "type":"string", + "enum":[ + "TIMER_ID_UNKNOWN", + "OPERATION_NOT_PERMITTED" + ] + }, + "CancelTimerFailedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

\n The timerId provided in the CancelTimer decision that failed.\n

" + }, + "cause":{ + "shape":"CancelTimerFailedCause", + "documentation":"

\n The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.\n

\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelTimer decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the CancelTimerFailed event.\n

" + }, + "CancelWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "details":{ + "shape":"Data", + "documentation":"

\n\t\tOptional details of the cancellation.\n

" + } + }, + "documentation":"

Provides details of the CancelWorkflowExecution decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "CancelWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "CancelWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{ + "shape":"CancelWorkflowExecutionFailedCause", + "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the CancelWorkflowExecutionFailed event.\n

" + }, + "Canceled":{"type":"boolean"}, + "ChildPolicy":{ + "type":"string", + "enum":[ + "TERMINATE", + "REQUEST_CANCEL", + "ABANDON" + ] + }, + "ChildWorkflowExecutionCanceledEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The child workflow execution that was canceled.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The type of the child workflow execution.\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n Details of the cancellation (if provided).\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provide details of the ChildWorkflowExecutionCanceled event.\n

" + }, + "ChildWorkflowExecutionCompletedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The child workflow execution that was completed.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The type of the child workflow execution.\n

" + }, + "result":{ + "shape":"Data", + "documentation":"

\n The result of the child workflow execution (if any).\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ChildWorkflowExecutionCompleted event.\n

" + }, + "ChildWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The child workflow execution that failed.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The type of the child workflow execution.\n

" + }, + "reason":{ + "shape":"FailureReason", + "documentation":"

\n The reason for the failure (if provided).\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n The details of the failure (if provided).\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ChildWorkflowExecutionFailed event.\n

" + }, + "ChildWorkflowExecutionStartedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The child workflow execution that was started.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The type of the child workflow execution.\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ChildWorkflowExecutionStarted event.\n

" + }, + "ChildWorkflowExecutionTerminatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The child workflow execution that was terminated.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The type of the child workflow execution.\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ChildWorkflowExecutionTerminated event.\n

" + }, + "ChildWorkflowExecutionTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "timeoutType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The child workflow execution that timed out.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The type of the child workflow execution.\n

" + }, + "timeoutType":{ + "shape":"WorkflowExecutionTimeoutType", + "documentation":"

\n The type of the timeout that caused the child workflow execution to time out.\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ChildWorkflowExecutionTimedOut event.\n

" + }, + "CloseStatus":{ + "type":"string", + "enum":[ + "COMPLETED", + "FAILED", + "CANCELED", + "TERMINATED", + "CONTINUED_AS_NEW", + "TIMED_OUT" + ] + }, + "CloseStatusFilter":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"CloseStatus", + "documentation":"

\n\t\tThe close status that must match the close status of an execution for it to meet the criteria of this filter. This\n\t\tfield is required.\n

" + } + }, + "documentation":"

\n\t\tUsed to filter the closed workflow executions in visibility APIs by their close status.\n

" + }, + "CompleteWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "result":{ + "shape":"Data", + "documentation":"

\n\t\tThe result of the workflow execution. The form of the result is implementation defined.\n

" + } + }, + "documentation":"

Provides details of the CompleteWorkflowExecution decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "CompleteWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "CompleteWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{ + "shape":"CompleteWorkflowExecutionFailedCause", + "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the CompleteWorkflowExecutionFailed event.\n

" + }, + "ContinueAsNewWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "input":{ + "shape":"Data", + "documentation":"

\n\t\tThe input provided to the new workflow execution.\n

" + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tIf set, specifies the total duration for this workflow execution. This overrides\n\t\tthe defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n\tAn execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field.\n\tIf neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned." + }, + "taskList":{"shape":"TaskList"}, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tSpecifies the maximum duration of decision tasks for the new workflow execution.\n\t\t\tThis parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.\n\t\t

\n\t\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n\t\tA task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter.\n\t\tIf neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned." + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\t\tIf set, specifies the policy to use for the child workflow executions of the new execution if it is terminated\n\t\t\tby calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\t\t\tThis policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n\t\t\tThe supported child policies are:

\n\n\t\t\t\n \tA child policy for the new workflow execution must be specified either as a default registered for its workflow type\n \tor through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.\n \t" + }, + "tagList":{ + "shape":"TagList", + "documentation":"

\n\t\tThe list of tags to associate with the new workflow execution. A maximum\n \t\tof 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions\n \t\tor ListClosedWorkflowExecutions and specifying a TagFilter.\n \t

" + }, + "workflowTypeVersion":{"shape":"Version"} + }, + "documentation":"

Provides details of the ContinueAsNewWorkflowExecution decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "ContinueAsNewWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "WORKFLOW_TYPE_DEPRECATED", + "WORKFLOW_TYPE_DOES_NOT_EXIST", + "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_CHILD_POLICY_UNDEFINED", + "OPERATION_NOT_PERMITTED" + ] + }, + "ContinueAsNewWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{ + "shape":"ContinueAsNewWorkflowExecutionFailedCause", + "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the ContinueAsNewWorkflowExecutionFailed event.\n

" + }, + "Count":{ + "type":"integer", + "min":0 + }, + "CountClosedWorkflowExecutionsInput":{ + "type":"structure", + "required":["domain"], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain containing the workflow executions to count.\n

" + }, + "startTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

\n If specified, only workflow executions that meet the start time criteria of the filter are counted.\n

\n startTimeFilter and closeTimeFilter are mutually exclusive.\n You must specify one of these in a request but not both." + }, + "closeTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

\n If specified, only workflow executions that meet the close time criteria of the filter are counted.\n

\n startTimeFilter and closeTimeFilter are mutually exclusive.\n You must specify one of these in a request but not both." + }, + "executionFilter":{ + "shape":"WorkflowExecutionFilter", + "documentation":"

\n If specified, only workflow executions matching the WorkflowId in the filter are counted.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "typeFilter":{ + "shape":"WorkflowTypeFilter", + "documentation":"

\n If specified, indicates the type of the workflow executions to be counted.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "tagFilter":{ + "shape":"TagFilter", + "documentation":"

\n If specified, only executions that have a tag that matches the filter are counted.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "closeStatusFilter":{ + "shape":"CloseStatusFilter", + "documentation":"

\n If specified, only workflow executions that match this close status are counted. \n This filter has an affect only if executionStatus\n is specified as CLOSED.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + } + } + }, + "CountOpenWorkflowExecutionsInput":{ + "type":"structure", + "required":[ + "domain", + "startTimeFilter" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain containing the workflow executions to count.\n

" + }, + "startTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

\n Specifies the start time criteria that workflow executions must meet in order to be counted.\n

" + }, + "typeFilter":{ + "shape":"WorkflowTypeFilter", + "documentation":"

\n Specifies the type of the workflow executions to be counted.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "tagFilter":{ + "shape":"TagFilter", + "documentation":"

\n If specified, only executions that have a tag that matches the filter are counted.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "executionFilter":{ + "shape":"WorkflowExecutionFilter", + "documentation":"

\n If specified, only workflow executions matching the WorkflowId in the filter are counted.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + } + } + }, + "CountPendingActivityTasksInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain that contains the task list.\n

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n The name of the task list.\n

" + } + } + }, + "CountPendingDecisionTasksInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain that contains the task list.\n

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n The name of the task list.\n

" + } + } + }, + "Data":{ + "type":"string", + "max":32768 + }, + "Decision":{ + "type":"structure", + "required":["decisionType"], + "members":{ + "decisionType":{ + "shape":"DecisionType", + "documentation":"

\n\t\tSpecifies the type of the decision.\n

" + }, + "scheduleActivityTaskDecisionAttributes":{ + "shape":"ScheduleActivityTaskDecisionAttributes", + "documentation":"

\n\t\tProvides details of the ScheduleActivityTask decision. It is not set for other decision types.\n

" + }, + "requestCancelActivityTaskDecisionAttributes":{ + "shape":"RequestCancelActivityTaskDecisionAttributes", + "documentation":"

\n\t\tProvides details of the RequestCancelActivityTask decision. It is not set for other decision types.\n

" + }, + "completeWorkflowExecutionDecisionAttributes":{ + "shape":"CompleteWorkflowExecutionDecisionAttributes", + "documentation":"

\n\t\tProvides details of the CompleteWorkflowExecution decision. It is not set for other decision types.\n

" + }, + "failWorkflowExecutionDecisionAttributes":{ + "shape":"FailWorkflowExecutionDecisionAttributes", + "documentation":"

\n\t\tProvides details of the FailWorkflowExecution decision. It is not set for other decision types.\n

" + }, + "cancelWorkflowExecutionDecisionAttributes":{ + "shape":"CancelWorkflowExecutionDecisionAttributes", + "documentation":"

\n\t\tProvides details of the CancelWorkflowExecution decision. It is not set for other decision types.\n

" + }, + "continueAsNewWorkflowExecutionDecisionAttributes":{ + "shape":"ContinueAsNewWorkflowExecutionDecisionAttributes", + "documentation":"

\n\t\tProvides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.\n

" + }, + "recordMarkerDecisionAttributes":{ + "shape":"RecordMarkerDecisionAttributes", + "documentation":"

\n\t\tProvides details of the RecordMarker decision. It is not set for other decision types.\n

" + }, + "startTimerDecisionAttributes":{ + "shape":"StartTimerDecisionAttributes", + "documentation":"

\n\t\tProvides details of the StartTimer decision. It is not set for other decision types.\n

" + }, + "cancelTimerDecisionAttributes":{ + "shape":"CancelTimerDecisionAttributes", + "documentation":"

\n\t\tProvides details of the CancelTimer decision. It is not set for other decision types.\n

" + }, + "signalExternalWorkflowExecutionDecisionAttributes":{ + "shape":"SignalExternalWorkflowExecutionDecisionAttributes", + "documentation":"

\n\t\tProvides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.\n

" + }, + "requestCancelExternalWorkflowExecutionDecisionAttributes":{ + "shape":"RequestCancelExternalWorkflowExecutionDecisionAttributes", + "documentation":"

\n\t\tProvides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.\n

" + }, + "startChildWorkflowExecutionDecisionAttributes":{ + "shape":"StartChildWorkflowExecutionDecisionAttributes", + "documentation":"

\n\t\tProvides details of the StartChildWorkflowExecution decision. It is not set for other decision types.\n

" + } + }, + "documentation":"

\n \t\tSpecifies a decision made by the decider. A decision can be one of these types:\n \t

\n \t\n\n

Access Control

\n

If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions\n returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps\n keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

\n \n

Decision Failure

\t\n

Decisions can fail for several reasons

\n \n

One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause.\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. \n\t\t\t

\n\n \t\t\n\n\t\t\t

\n\t\t\t\tThe preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.\n\t\t\t

\n\n \t\t\n \t\t\tA workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task:\n \t\t\tCompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution\n \t\t\tand ContinueAsNewWorkflowExecution.\n \t\t\tAn UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal\n \t\t\tor activity event had been added to the history while the decision task was being performed by the decider.\n \t\t\tUnlike the above situations which are\n \t\t\tlogic issues, this fault is always possible because of race conditions in a distributed system. The right\n \t\t\taction here is to call RespondDecisionTaskCompleted without any decisions. This would result in\n \t\t\tanother decision task with these new events included in the history. The decider should handle the new events and\n \t\t\tmay decide to close the workflow execution.\n \t\t\n\n

How to Code a Decision

\n

\n \t\t\tYou code a decision by first setting the\n \t\t\tdecision type field to one of the above decision values, and then set the corresponding attributes field\n \t\t\tshown below:\n \t\t

\n \t\t" + }, + "DecisionList":{ + "type":"list", + "member":{"shape":"Decision"} + }, + "DecisionTask":{ + "type":"structure", + "required":[ + "taskToken", + "startedEventId", + "workflowExecution", + "workflowType", + "events" + ], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

\n\t \tThe opaque string used as a handle on the task. This token is used by workers to\n \t\tcommunicate progress and response information back to the system about\n \t\tthe task.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n\t\tThe id of the DecisionTaskStarted event recorded in the history.\n

" + }, + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n\t\tThe workflow execution for which this decision task was created.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n\t\tThe type of the workflow execution for which this decision task was created.\n

" + }, + "events":{ + "shape":"HistoryEventList", + "documentation":"

\n\t\tA paginated list of history events of the workflow execution. The decider uses this\n\t\tduring the processing of the decision task.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n\t\tReturns a value if the results are paginated. To get the next page of results,\n\t\trepeat the request specifying this token and all other arguments unchanged.\n

" + }, + "previousStartedEventId":{ + "shape":"EventId", + "documentation":"

\n \tThe id of the DecisionTaskStarted event of the previous decision task of this workflow execution\n \tthat was processed by the decider. This can be used to determine the events in the history new since the\n \tlast decision task received by the decider.\n

" + } + }, + "documentation":"

\n\t\tA structure that represents a decision task. Decision tasks are sent to\n\t\tdeciders in order for them to make decisions.\n

" + }, + "DecisionTaskCompletedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "executionContext":{ + "shape":"Data", + "documentation":"

\n User defined context for the workflow execution.\n

" + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the DecisionTaskCompleted event.\n

" + }, + "DecisionTaskScheduledEventAttributes":{ + "type":"structure", + "required":["taskList"], + "members":{ + "taskList":{ + "shape":"TaskList", + "documentation":"

\n The name of the task list in which the decision task was scheduled.\n

" + }, + "startToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n The maximum duration for this decision task. The task is considered timed out if it does not\n completed within this duration.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + } + }, + "documentation":"

\n Provides details of the DecisionTaskScheduled event.\n

" + }, + "DecisionTaskStartedEventAttributes":{ + "type":"structure", + "required":["scheduledEventId"], + "members":{ + "identity":{ + "shape":"Identity", + "documentation":"

\n Identity of the decider making the request. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n

" + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the DecisionTaskStarted event.\n

" + }, + "DecisionTaskTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members":{ + "timeoutType":{ + "shape":"DecisionTaskTimeoutType", + "documentation":"

\n The type of timeout that expired before the decision task could be completed.\n

" + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The Id of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the DecisionTaskTimedOut event.\n

" + }, + "DecisionTaskTimeoutType":{ + "type":"string", + "enum":["START_TO_CLOSE"] + }, + "DecisionType":{ + "type":"string", + "enum":[ + "ScheduleActivityTask", + "RequestCancelActivityTask", + "CompleteWorkflowExecution", + "FailWorkflowExecution", + "CancelWorkflowExecution", + "ContinueAsNewWorkflowExecution", + "RecordMarker", + "StartTimer", + "CancelTimer", + "SignalExternalWorkflowExecution", + "RequestCancelExternalWorkflowExecution", + "StartChildWorkflowExecution" + ] + }, + "DefaultUndefinedFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DeprecateActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "activityType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain in which the activity type is registered.\n

" + }, + "activityType":{ + "shape":"ActivityType", + "documentation":"

\n The activity type to deprecate.\n

" + } + } + }, + "DeprecateDomainInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

\n\t\t\tThe name of the domain to deprecate.\n\t\t

" + } + } + }, + "DeprecateWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "workflowType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain in which the workflow type is registered.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The workflow type to deprecate.\n

" + } + } + }, + "DescribeActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "activityType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain in which the activity type is registered.\n

" + }, + "activityType":{ + "shape":"ActivityType", + "documentation":"

\n The activity type to describe.\n

" + } + } + }, + "DescribeDomainInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

\n\t\t\tThe name of the domain to describe.\n\t\t

" + } + } + }, + "DescribeWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "execution" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain containing the workflow execution.\n

" + }, + "execution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The workflow execution to describe.\n

" + } + } + }, + "DescribeWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "workflowType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain in which this workflow type is registered.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The workflow type to describe.\n

" + } + } + }, + "Description":{ + "type":"string", + "max":1024 + }, + "DomainAlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\n A description that may help with diagnosing the cause of the fault.\n

" + } + }, + "exception":true, + "documentation":"

\n Returned if the specified domain already exists. You will\n get this fault even if the existing domain is in deprecated status.\n

" + }, + "DomainConfiguration":{ + "type":"structure", + "required":["workflowExecutionRetentionPeriodInDays"], + "members":{ + "workflowExecutionRetentionPeriodInDays":{ + "shape":"DurationInDays", + "documentation":"

\n The retention period for workflow executions in this domain.\n

" + } + }, + "documentation":"

\n Contains the configuration settings of a domain.\n

" + }, + "DomainDeprecatedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\n\t\tA description that may help with diagnosing the cause of the fault.\n

" + } + }, + "exception":true, + "documentation":"

\n\t\tReturned when the specified domain has been deprecated.\n

" + }, + "DomainDetail":{ + "type":"structure", + "required":[ + "domainInfo", + "configuration" + ], + "members":{ + "domainInfo":{"shape":"DomainInfo"}, + "configuration":{"shape":"DomainConfiguration"} + }, + "documentation":"

\n\t\tContains details of a domain.\n

" + }, + "DomainInfo":{ + "type":"structure", + "required":[ + "name", + "status" + ], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

\n\t\tThe name of the domain. This name is unique within the account.\n

" + }, + "status":{ + "shape":"RegistrationStatus", + "documentation":"

\n\t\tThe status of the domain:\n\t

\n\t" + }, + "description":{ + "shape":"Description", + "documentation":"

\n\t\tThe description of the domain provided through RegisterDomain.\n

" + } + }, + "documentation":"

\n\t\tContains general information about a domain.\n

" + }, + "DomainInfoList":{ + "type":"list", + "member":{"shape":"DomainInfo"} + }, + "DomainInfos":{ + "type":"structure", + "required":["domainInfos"], + "members":{ + "domainInfos":{ + "shape":"DomainInfoList", + "documentation":"

\n\t\tA list of DomainInfo structures.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n\t \tReturns a value if the results are paginated. To get the next page of results, repeat the request\n\t \tspecifying this token and all other arguments unchanged.\n

" + } + }, + "documentation":"

\n\t\tContains a paginated collection of DomainInfo structures.\n

" + }, + "DomainName":{ + "type":"string", + "min":1, + "max":256 + }, + "DurationInDays":{ + "type":"string", + "min":1, + "max":8 + }, + "DurationInSeconds":{ + "type":"string", + "min":1, + "max":8 + }, + "DurationInSecondsOptional":{ + "type":"string", + "max":8 + }, + "ErrorMessage":{"type":"string"}, + "EventId":{"type":"long"}, + "EventType":{ + "type":"string", + "enum":[ + "WorkflowExecutionStarted", + "WorkflowExecutionCancelRequested", + "WorkflowExecutionCompleted", + "CompleteWorkflowExecutionFailed", + "WorkflowExecutionFailed", + "FailWorkflowExecutionFailed", + "WorkflowExecutionTimedOut", + "WorkflowExecutionCanceled", + "CancelWorkflowExecutionFailed", + "WorkflowExecutionContinuedAsNew", + "ContinueAsNewWorkflowExecutionFailed", + "WorkflowExecutionTerminated", + "DecisionTaskScheduled", + "DecisionTaskStarted", + "DecisionTaskCompleted", + "DecisionTaskTimedOut", + "ActivityTaskScheduled", + "ScheduleActivityTaskFailed", + "ActivityTaskStarted", + "ActivityTaskCompleted", + "ActivityTaskFailed", + "ActivityTaskTimedOut", + "ActivityTaskCanceled", + "ActivityTaskCancelRequested", + "RequestCancelActivityTaskFailed", + "WorkflowExecutionSignaled", + "MarkerRecorded", + "RecordMarkerFailed", + "TimerStarted", + "StartTimerFailed", + "TimerFired", + "TimerCanceled", + "CancelTimerFailed", + "StartChildWorkflowExecutionInitiated", + "StartChildWorkflowExecutionFailed", + "ChildWorkflowExecutionStarted", + "ChildWorkflowExecutionCompleted", + "ChildWorkflowExecutionFailed", + "ChildWorkflowExecutionTimedOut", + "ChildWorkflowExecutionCanceled", + "ChildWorkflowExecutionTerminated", + "SignalExternalWorkflowExecutionInitiated", + "SignalExternalWorkflowExecutionFailed", + "ExternalWorkflowExecutionSignaled", + "RequestCancelExternalWorkflowExecutionInitiated", + "RequestCancelExternalWorkflowExecutionFailed", + "ExternalWorkflowExecutionCancelRequested" + ] + }, + "ExecutionStatus":{ + "type":"string", + "enum":[ + "OPEN", + "CLOSED" + ] + }, + "ExecutionTimeFilter":{ + "type":"structure", + "required":["oldestDate"], + "members":{ + "oldestDate":{ + "shape":"Timestamp", + "documentation":"

\n\t\tSpecifies the oldest start or close date and time to return.\n

" + }, + "latestDate":{ + "shape":"Timestamp", + "documentation":"

\n\t\tSpecifies the latest start or close date and time to return.\n

" + } + }, + "documentation":"

\n \t\tUsed to filter the workflow executions in visibility APIs by various time-based\n \t\trules. Each parameter, if specified, defines a rule that must be satisfied by\n \t\teach returned query result. The parameter values are in the Unix Time format.\n For example: \"oldestDate\": 1325376070.\n

" + }, + "ExternalWorkflowExecutionCancelRequestedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The external workflow execution to which the cancellation request was delivered.\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ExternalWorkflowExecutionCancelRequested event.\n

" + }, + "ExternalWorkflowExecutionSignaledEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The external workflow execution that the signal was delivered to.\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ExternalWorkflowExecutionSignaled event.\n

" + }, + "FailWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "reason":{ + "shape":"FailureReason", + "documentation":"

\n\t\tA descriptive reason for the failure that may help in diagnostics.\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n\t\tOptional details of the failure.\n

" + } + }, + "documentation":"

Provides details of the FailWorkflowExecution decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "FailWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "FailWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{ + "shape":"FailWorkflowExecutionFailedCause", + "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the FailWorkflowExecution decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the FailWorkflowExecutionFailed event.\n

" + }, + "FailureReason":{ + "type":"string", + "max":256 + }, + "GetWorkflowExecutionHistoryInput":{ + "type":"structure", + "required":[ + "domain", + "execution" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain containing the workflow execution.\n

" + }, + "execution":{ + "shape":"WorkflowExecution", + "documentation":"

\n Specifies the workflow execution for which to return the history.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n If a NextPageToken is returned, the result has more than one pages. To get the next page,\n repeat the call and specify the nextPageToken with all other arguments unchanged.\n

" + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

\n Specifies the maximum number of history events returned in one page.\n The next page in the result is identified by the NextPageToken returned.\n By default 100 history events are returned in a page but the caller can override this\n value to a page size smaller than the default. You cannot specify a page size\n larger than 100.\n Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

" + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

\n When set to true, returns the events in reverse order. By default the results are returned in ascending order\n of the eventTimeStamp of the events.\n

" + } + } + }, + "History":{ + "type":"structure", + "required":["events"], + "members":{ + "events":{ + "shape":"HistoryEventList", + "documentation":"

\n\t\tThe list of history events.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n\t\tThe token for the next page. If set, the history consists of more than one page and the next page can be retrieved by repeating the request\n\t\twith this token and all other arguments unchanged.\n

" + } + }, + "documentation":"

\n\t\tPaginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of\n\t\tthe events related to all tasks and events in the life of the workflow execution.\n

" + }, + "HistoryEvent":{ + "type":"structure", + "required":[ + "eventTimestamp", + "eventType", + "eventId" + ], + "members":{ + "eventTimestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe date and time when the event occurred.\n

" + }, + "eventType":{ + "shape":"EventType", + "documentation":"

\n \t\tThe type of the history event.\n \t

" + }, + "eventId":{ + "shape":"EventId", + "documentation":"

\n\t\tThe system generated id of the event. This id uniquely identifies the event with in the workflow execution history.\n

" + }, + "workflowExecutionStartedEventAttributes":{ + "shape":"WorkflowExecutionStartedEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionStarted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "workflowExecutionCompletedEventAttributes":{ + "shape":"WorkflowExecutionCompletedEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionCompleted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "completeWorkflowExecutionFailedEventAttributes":{ + "shape":"CompleteWorkflowExecutionFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type CompleteWorkflowExecutionFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "workflowExecutionFailedEventAttributes":{ + "shape":"WorkflowExecutionFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionFailed then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "failWorkflowExecutionFailedEventAttributes":{ + "shape":"FailWorkflowExecutionFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type FailWorkflowExecutionFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "workflowExecutionTimedOutEventAttributes":{ + "shape":"WorkflowExecutionTimedOutEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionTimedOut then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "workflowExecutionCanceledEventAttributes":{ + "shape":"WorkflowExecutionCanceledEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionCanceled then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "cancelWorkflowExecutionFailedEventAttributes":{ + "shape":"CancelWorkflowExecutionFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type CancelWorkflowExecutionFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "workflowExecutionContinuedAsNewEventAttributes":{ + "shape":"WorkflowExecutionContinuedAsNewEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionContinuedAsNew then this member is set and\n\t\tprovides detailed information about the event. It is not set for other event types.\n

" + }, + "continueAsNewWorkflowExecutionFailedEventAttributes":{ + "shape":"ContinueAsNewWorkflowExecutionFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ContinueAsNewWorkflowExecutionFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "workflowExecutionTerminatedEventAttributes":{ + "shape":"WorkflowExecutionTerminatedEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionTerminated then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "workflowExecutionCancelRequestedEventAttributes":{ + "shape":"WorkflowExecutionCancelRequestedEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionCancelRequested then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "decisionTaskScheduledEventAttributes":{ + "shape":"DecisionTaskScheduledEventAttributes", + "documentation":"

\n\t\tIf the event is of type DecisionTaskScheduled then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "decisionTaskStartedEventAttributes":{ + "shape":"DecisionTaskStartedEventAttributes", + "documentation":"

\n\t\tIf the event is of type DecisionTaskStarted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "decisionTaskCompletedEventAttributes":{ + "shape":"DecisionTaskCompletedEventAttributes", + "documentation":"

\n\t\tIf the event is of type DecisionTaskCompleted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "decisionTaskTimedOutEventAttributes":{ + "shape":"DecisionTaskTimedOutEventAttributes", + "documentation":"

\n\t\tIf the event is of type DecisionTaskTimedOut then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "activityTaskScheduledEventAttributes":{ + "shape":"ActivityTaskScheduledEventAttributes", + "documentation":"

\n\t\tIf the event is of type ActivityTaskScheduled then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "activityTaskStartedEventAttributes":{ + "shape":"ActivityTaskStartedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ActivityTaskStarted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "activityTaskCompletedEventAttributes":{ + "shape":"ActivityTaskCompletedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ActivityTaskCompleted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "activityTaskFailedEventAttributes":{ + "shape":"ActivityTaskFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ActivityTaskFailed then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "activityTaskTimedOutEventAttributes":{ + "shape":"ActivityTaskTimedOutEventAttributes", + "documentation":"

\n\t\tIf the event is of type ActivityTaskTimedOut then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "activityTaskCanceledEventAttributes":{ + "shape":"ActivityTaskCanceledEventAttributes", + "documentation":"

\n\t\tIf the event is of type ActivityTaskCanceled then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "activityTaskCancelRequestedEventAttributes":{ + "shape":"ActivityTaskCancelRequestedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ActivityTaskcancelRequested then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "workflowExecutionSignaledEventAttributes":{ + "shape":"WorkflowExecutionSignaledEventAttributes", + "documentation":"

\n\t\tIf the event is of type WorkflowExecutionSignaled then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "markerRecordedEventAttributes":{ + "shape":"MarkerRecordedEventAttributes", + "documentation":"

\n\t\tIf the event is of type MarkerRecorded then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "recordMarkerFailedEventAttributes":{ + "shape":"RecordMarkerFailedEventAttributes", + "documentation":"

\n If the event is of type DecisionTaskFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

" + }, + "timerStartedEventAttributes":{ + "shape":"TimerStartedEventAttributes", + "documentation":"

\n\t\tIf the event is of type TimerStarted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "timerFiredEventAttributes":{ + "shape":"TimerFiredEventAttributes", + "documentation":"

\n\t\tIf the event is of type TimerFired then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "timerCanceledEventAttributes":{ + "shape":"TimerCanceledEventAttributes", + "documentation":"

\n\t\tIf the event is of type TimerCanceled then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "startChildWorkflowExecutionInitiatedEventAttributes":{ + "shape":"StartChildWorkflowExecutionInitiatedEventAttributes", + "documentation":"

\n\t\tIf the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "childWorkflowExecutionStartedEventAttributes":{ + "shape":"ChildWorkflowExecutionStartedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ChildWorkflowExecutionStarted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "childWorkflowExecutionCompletedEventAttributes":{ + "shape":"ChildWorkflowExecutionCompletedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ChildWorkflowExecutionCompleted then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "childWorkflowExecutionFailedEventAttributes":{ + "shape":"ChildWorkflowExecutionFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ChildWorkflowExecutionFailed then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "childWorkflowExecutionTimedOutEventAttributes":{ + "shape":"ChildWorkflowExecutionTimedOutEventAttributes", + "documentation":"

\n\t\tIf the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "childWorkflowExecutionCanceledEventAttributes":{ + "shape":"ChildWorkflowExecutionCanceledEventAttributes", + "documentation":"

\n\t\tIf the event is of type ChildWorkflowExecutionCanceled then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "childWorkflowExecutionTerminatedEventAttributes":{ + "shape":"ChildWorkflowExecutionTerminatedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ChildWorkflowExecutionTerminated then this member is set and provides\n\t\tdetailed information about the event. It is not set for other event types.\n

" + }, + "signalExternalWorkflowExecutionInitiatedEventAttributes":{ + "shape":"SignalExternalWorkflowExecutionInitiatedEventAttributes", + "documentation":"

\n\t\tIf the event is of type SignalExternalWorkflowExecutionInitiated then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "externalWorkflowExecutionSignaledEventAttributes":{ + "shape":"ExternalWorkflowExecutionSignaledEventAttributes", + "documentation":"

\n\t\tIf the event is of type ExternalWorkflowExecutionSignaled then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "signalExternalWorkflowExecutionFailedEventAttributes":{ + "shape":"SignalExternalWorkflowExecutionFailedEventAttributes", + "documentation":"

If the event is of type SignalExternalWorkflowExecutionFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.

" + }, + "externalWorkflowExecutionCancelRequestedEventAttributes":{ + "shape":"ExternalWorkflowExecutionCancelRequestedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ExternalWorkflowExecutionCancelRequested then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "requestCancelExternalWorkflowExecutionInitiatedEventAttributes":{ + "shape":"RequestCancelExternalWorkflowExecutionInitiatedEventAttributes", + "documentation":"

\n\t\tIf the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "requestCancelExternalWorkflowExecutionFailedEventAttributes":{ + "shape":"RequestCancelExternalWorkflowExecutionFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type RequestCancelExternalWorkflowExecutionFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "scheduleActivityTaskFailedEventAttributes":{ + "shape":"ScheduleActivityTaskFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type ScheduleActivityTaskFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "requestCancelActivityTaskFailedEventAttributes":{ + "shape":"RequestCancelActivityTaskFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type RequestCancelActivityTaskFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "startTimerFailedEventAttributes":{ + "shape":"StartTimerFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type StartTimerFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "cancelTimerFailedEventAttributes":{ + "shape":"CancelTimerFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type CancelTimerFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + }, + "startChildWorkflowExecutionFailedEventAttributes":{ + "shape":"StartChildWorkflowExecutionFailedEventAttributes", + "documentation":"

\n\t\tIf the event is of type StartChildWorkflowExecutionFailed then this member\n\t\tis set and provides detailed information about the event. It is not set for other event types.\n

" + } + }, + "documentation":"

\n\t \tEvent within a workflow execution.\tA history event can be one of these types:\n

\n \t" + }, + "HistoryEventList":{ + "type":"list", + "member":{"shape":"HistoryEvent"} + }, + "Identity":{ + "type":"string", + "max":256 + }, + "LimitExceededFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\n A description that may help with diagnosing the cause of the fault.\n

" + } + }, + "exception":true, + "documentation":"

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

" + }, + "LimitedData":{ + "type":"string", + "max":2048 + }, + "ListActivityTypesInput":{ + "type":"structure", + "required":[ + "domain", + "registrationStatus" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain in which the activity types have been registered.\n

" + }, + "name":{ + "shape":"Name", + "documentation":"

\n If specified, only lists the activity types that have this name.\n

" + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"

\n Specifies the registration status of the activity types to list.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n If on a previous call to this method a NextResultToken was returned, the results have\n more than one page. To get the next page of results, repeat the call with the nextPageToken\n and keep all other arguments unchanged.\n

" + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

" + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

\n When set to true, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the name of the activity types.\n

" + } + } + }, + "ListClosedWorkflowExecutionsInput":{ + "type":"structure", + "required":["domain"], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain that contains the workflow executions to list.\n

" + }, + "startTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

\n If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.\n Also, if this parameter is specified, the returned results are ordered by their start times.\n

\n startTimeFilter and closeTimeFilter are mutually exclusive.\n You must specify one of these in a request but not both." + }, + "closeTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

\n If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter.\n Also, if this parameter is specified, the returned results are ordered by their close times.\n

\n startTimeFilter and closeTimeFilter are mutually exclusive.\n You must specify one of these in a request but not both." + }, + "executionFilter":{ + "shape":"WorkflowExecutionFilter", + "documentation":"

\n If specified, only workflow executions matching the workflow id specified in the filter are returned.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "closeStatusFilter":{ + "shape":"CloseStatusFilter", + "documentation":"

\n If specified, only workflow executions that match this close status are listed.\n For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "typeFilter":{ + "shape":"WorkflowTypeFilter", + "documentation":"

\n If specified, only executions of the type specified in the filter are returned.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "tagFilter":{ + "shape":"TagFilter", + "documentation":"

\n If specified, only executions that have the matching tag are listed.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n If on a previous call to this method a NextPageToken was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n

" + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

" + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

\n When set to true, returns the results in reverse order. By default the results are returned in\n descending order of the start or the close time of the executions.\n

" + } + } + }, + "ListDomainsInput":{ + "type":"structure", + "required":["registrationStatus"], + "members":{ + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n\t \t\tIf on a previous call to this method a NextPageToken was returned, the result has\n\t \t\tmore than one page. To get the next page of results, repeat the call with the returned token\n\t \t\tand all other arguments unchanged.\n\t\t

" + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"

\n \t\t\tSpecifies the registration status of the domains to list.\n\t\t

" + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

\n\t\t\t The maximum number of results returned in each page. The default is 100, but the caller\n \t\t\t can override this value to a page size smaller than the default. You cannot specify\n \t\t\t a page size greater than 100.\n Note that the number of domains may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n\t\t

" + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

\n\t\t\tWhen set to true, returns the results in reverse order. By default the results are returned in ascending\n\t\t\talphabetical order of the name of the domains.\n\t\t

" + } + } + }, + "ListOpenWorkflowExecutionsInput":{ + "type":"structure", + "required":[ + "domain", + "startTimeFilter" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain that contains the workflow executions to list.\n

" + }, + "startTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

\n Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.\n

" + }, + "typeFilter":{ + "shape":"WorkflowTypeFilter", + "documentation":"

\n If specified, only executions of the type specified in the filter are returned.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "tagFilter":{ + "shape":"TagFilter", + "documentation":"

\n If specified, only executions that have the matching tag are listed.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n If on a previous call to this method a NextPageToken was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n

" + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

" + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

\n When set to true, returns the results in reverse order. By default the results are returned in\n descending order of the start time of the executions.\n

" + }, + "executionFilter":{ + "shape":"WorkflowExecutionFilter", + "documentation":"

\n If specified, only workflow executions matching the workflow id specified in the filter are returned.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request." + } + } + }, + "ListWorkflowTypesInput":{ + "type":"structure", + "required":[ + "domain", + "registrationStatus" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain in which the workflow types have been registered.\n

" + }, + "name":{ + "shape":"Name", + "documentation":"

\n If specified, lists the workflow type with this name.\n

" + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"

\n Specifies the registration status of the workflow types to list.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n If on a previous call to this method a NextPageToken was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and all other arguments\n unchanged.\n

" + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

" + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

\n When set to true, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the name of the workflow types.\n

" + } + } + }, + "MarkerName":{ + "type":"string", + "min":1, + "max":256 + }, + "MarkerRecordedEventAttributes":{ + "type":"structure", + "required":[ + "markerName", + "decisionTaskCompletedEventId" + ], + "members":{ + "markerName":{ + "shape":"MarkerName", + "documentation":"

\n The name of the marker.\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n Details of the marker (if any).\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RecordMarker decision that requested this marker.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the MarkerRecorded event.\n

" + }, + "Name":{ + "type":"string", + "min":1, + "max":256 + }, + "OpenDecisionTasksCount":{ + "type":"integer", + "min":0, + "max":1 + }, + "OperationNotPermittedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\n\t\tA description that may help with diagnosing the cause of the fault.\n

" + } + }, + "exception":true, + "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" + }, + "PageSize":{ + "type":"integer", + "min":0, + "max":1000 + }, + "PageToken":{ + "type":"string", + "max":2048 + }, + "PendingTaskCount":{ + "type":"structure", + "required":["count"], + "members":{ + "count":{ + "shape":"Count", + "documentation":"

\n\t\tThe number of tasks in the task list.\n

" + }, + "truncated":{ + "shape":"Truncated", + "documentation":"

\n\t\tIf set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n

" + } + }, + "documentation":"

\n\t\tContains the count of tasks in a task list.\n

" + }, + "PollForActivityTaskInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain that contains the task lists being polled.\n

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n Specifies the task list to poll for activity tasks.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "identity":{ + "shape":"Identity", + "documentation":"

\n Identity of the worker making the request, which is recorded in the\n ActivityTaskStarted event in the workflow history. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n

" + } + } + }, + "PollForDecisionTaskInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain containing the task lists to poll.\n

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n Specifies the task list to poll for decision tasks.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "identity":{ + "shape":"Identity", + "documentation":"

\n Identity of the decider making the request, which is recorded in the\n DecisionTaskStarted event in the workflow history. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n If on a previous call to this method a NextPageToken was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n

\n The nextPageToken returned by this action cannot be used with\n GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again\n (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask\n with a nextPageToken will not return a new decision task.." + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

\n The maximum number of history events returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify a\n page size greater than 100.\n Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

" + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

\n When set to true, returns the events in reverse order. By default the results are returned in ascending order\n of the eventTimestamp of the events.\n

" + } + } + }, + "RecordActivityTaskHeartbeatInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

\n The taskToken of the ActivityTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n " + }, + "details":{ + "shape":"LimitedData", + "documentation":"

\n If specified, contains details about the progress of the task.\n

" + } + } + }, + "RecordMarkerDecisionAttributes":{ + "type":"structure", + "required":["markerName"], + "members":{ + "markerName":{ + "shape":"MarkerName", + "documentation":"

\n\t\tThe name of the marker.\n\t\tThis file is required.\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n\t\tOptional details of the marker.\n

" + } + }, + "documentation":"

Provides details of the RecordMarker decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "RecordMarkerFailedCause":{ + "type":"string", + "enum":["OPERATION_NOT_PERMITTED"] + }, + "RecordMarkerFailedEventAttributes":{ + "type":"structure", + "required":[ + "markerName", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "markerName":{ + "shape":"MarkerName", + "documentation":"

The marker's name.

" + }, + "cause":{ + "shape":"RecordMarkerFailedCause", + "documentation":"

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RecordMarkerFailed decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.

" + } + }, + "documentation":"

Provides details of the RecordMarkerFailed event.

" + }, + "RegisterActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "name", + "version" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain in which this activity is to be registered.\n

" + }, + "name":{ + "shape":"Name", + "documentation":"

\n The name of the activity type within the domain.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "version":{ + "shape":"Version", + "documentation":"

\n The version of the activity type.\n

\n \n The activity type consists of the name and version, the combination of which must be unique within the domain.\n \n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "description":{ + "shape":"Description", + "documentation":"

\n A textual description of the activity type.\n

" + }, + "defaultTaskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n If set, specifies the default maximum duration that a worker can take to process tasks of this activity type.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultTaskHeartbeatTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n If set, specifies the default maximum time before which a worker processing a task of this type must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.\n If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives\n an UnknownResource fault.\n In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultTaskList":{ + "shape":"TaskList", + "documentation":"

\n If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used\n if a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision.\n

" + }, + "defaultTaskScheduleToStartTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultTaskScheduleToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n If set, specifies the default maximum duration for a task of this activity type.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + } + } + }, + "RegisterDomainInput":{ + "type":"structure", + "required":[ + "name", + "workflowExecutionRetentionPeriodInDays" + ], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

\n\t\t\tName of the domain to register. The name must be unique.\n\t\t

\n\t\t

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "description":{ + "shape":"Description", + "documentation":"

\n\t\t\tTextual description of the domain.\n\t\t

" + }, + "workflowExecutionRetentionPeriodInDays":{ + "shape":"DurationInDays", + "documentation":"

\n\t\tSpecifies the duration--in days--for which the record (including the history) of workflow executions in this\n\t\tdomain should be kept by the service.\n\n\t\tAfter the retention period, the workflow execution will not be available in the results of visibility calls.\n\n\t\tIf a duration of NONE is specified, the records for workflow executions in this domain are not retained at all.\n\t

" + } + } + }, + "RegisterWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "name", + "version" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n\t\t\tThe name of the domain in which to register the workflow type.\n\t\t

" + }, + "name":{ + "shape":"Name", + "documentation":"

\n\t\t\tThe name of the workflow type.\n\t\t

\n\t\t

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "version":{ + "shape":"Version", + "documentation":"

\n\t\t\tThe version of the workflow type.\n\t\t

\n\t\t\n\t\t\tThe workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered\n\t\t\tworkflow types, use the ListWorkflowTypes action.\n\t\t\n\t\t

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "description":{ + "shape":"Description", + "documentation":"

\n\t\t\tTextual description of the workflow type.\n\t\t

" + }, + "defaultTaskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tIf set, specifies the default maximum duration of decision tasks for this workflow type. This\n\t\t\tdefault can be overridden when starting a workflow execution using the StartWorkflowExecution action or the\n\t\t\tStartChildWorkflowExecution Decision.\n\t\t

\n\t\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultExecutionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tIf set, specifies the default maximum duration for executions of this workflow type. You can\n\t\t\toverride this default when starting an execution through the StartWorkflowExecution Action or\n\t\t\tStartChildWorkflowExecution Decision.\n\t\t

\n\n\t\t

\n\t\t\tThe duration is specified in seconds. The valid values are integers greater than or equal to 0.\n\t\t\tUnlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a \n\t\t\tone-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.\n\t\t

" + }, + "defaultTaskList":{ + "shape":"TaskList", + "documentation":"

\n\t\t\tIf set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.\n\t\t\tThis default is used only if a task list is not provided when starting the execution\n\t\t\tthrough the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.\n\t\t

" + }, + "defaultChildPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\t\tIf set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated,\n\t\t\tby calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\t\t\tThis default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n\t\t\tthe StartChildWorkflowExecution Decision.\n\t\t\tThe supported child policies are:

\n\t\t\t" + } + } + }, + "RegistrationStatus":{ + "type":"string", + "enum":[ + "REGISTERED", + "DEPRECATED" + ] + }, + "RequestCancelActivityTaskDecisionAttributes":{ + "type":"structure", + "required":["activityId"], + "members":{ + "activityId":{ + "shape":"ActivityId", + "documentation":"

\n\t\tThe activityId of the activity task to be canceled.\n

" + } + }, + "documentation":"

Provides details of the RequestCancelActivityTask decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "RequestCancelActivityTaskFailedCause":{ + "type":"string", + "enum":[ + "ACTIVITY_ID_UNKNOWN", + "OPERATION_NOT_PERMITTED" + ] + }, + "RequestCancelActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityId":{ + "shape":"ActivityId", + "documentation":"

\n The activityId provided in the RequestCancelActivityTask decision that failed.\n

" + }, + "cause":{ + "shape":"RequestCancelActivityTaskFailedCause", + "documentation":"

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelActivityTask decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.

" + } + }, + "documentation":"

Provides details of the RequestCancelActivityTaskFailed event.

" + }, + "RequestCancelExternalWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":["workflowId"], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n\t\tThe workflowId of the external workflow execution to cancel.\n\t\tThis field is required.\n

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n\t\tThe runId of the external workflow execution to cancel.\n

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n\t\tOptional data attached to the event that can be used by the decider in subsequent workflow\n\t\ttasks.\n

" + } + }, + "documentation":"

Provides details of the RequestCancelExternalWorkflowExecution decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "RequestCancelExternalWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", + "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "RequestCancelExternalWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n The workflowId of the external workflow to which the cancel request was to be delivered.\n

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n The runId of the external workflow execution.\n

" + }, + "cause":{ + "shape":"RequestCancelExternalWorkflowExecutionFailedCause", + "documentation":"

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + }, + "control":{"shape":"Data"} + }, + "documentation":"

\n Provides details of the RequestCancelExternalWorkflowExecutionFailed event.\n

" + }, + "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n The workflowId of the external workflow execution to be canceled.\n

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n The runId of the external workflow execution to be canceled.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n

" + } + }, + "documentation":"

\n Provides details of the RequestCancelExternalWorkflowExecutionInitiated event.\n

" + }, + "RequestCancelWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain containing the workflow execution to cancel.\n

" + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n The workflowId of the workflow execution to cancel.\n

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n The runId of the workflow execution to cancel.\n

" + } + } + }, + "RespondActivityTaskCanceledInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

\n The taskToken of the ActivityTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n " + }, + "details":{ + "shape":"Data", + "documentation":"

\n Optional information about the cancellation.\n

" + } + } + }, + "RespondActivityTaskCompletedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

\n The taskToken of the ActivityTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n " + }, + "result":{ + "shape":"Data", + "documentation":"

\n The result of the activity task. It is a free form string that is implementation specific.\n

" + } + } + }, + "RespondActivityTaskFailedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

\n The taskToken of the ActivityTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n " + }, + "reason":{ + "shape":"FailureReason", + "documentation":"

\n Description of the error that may assist in diagnostics.\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n Optional detailed information about the failure.\n

" + } + } + }, + "RespondDecisionTaskCompletedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

\n The taskToken from the DecisionTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n " + }, + "decisions":{ + "shape":"DecisionList", + "documentation":"

\n The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs\n for the Decision structure for details.\n

" + }, + "executionContext":{ + "shape":"Data", + "documentation":"

\n User defined context to add to workflow execution.\n

" + } + } + }, + "ReverseOrder":{"type":"boolean"}, + "Run":{ + "type":"structure", + "members":{ + "runId":{ + "shape":"RunId", + "documentation":"

\n The runId of a workflow execution. This Id is generated by the service and can be used to uniquely identify\n the workflow execution within a domain.\n

" + } + }, + "documentation":"

\n Specifies the runId of a workflow execution.\n

" + }, + "RunId":{ + "type":"string", + "min":1, + "max":64 + }, + "RunIdOptional":{ + "type":"string", + "max":64 + }, + "ScheduleActivityTaskDecisionAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId" + ], + "members":{ + "activityType":{ + "shape":"ActivityType", + "documentation":"

\n\t\tThe type of the activity task to schedule.\n\t\tThis field is required.\n

" + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

\n\t\tThe activityId of the activity task.\n\t\tThis field is required.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n\t\tOptional data attached to the event that can be used by the decider in subsequent workflow\n\t\ttasks. This data is not sent to the activity.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n\t\tThe input provided to the activity task.\n

" + }, + "scheduleToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tThe maximum duration for this activity task.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n\tA schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field.\n\tIf neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned." + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n\t\tIf set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList\n\t\tregistered with the activity type will be used.\n

\n\tA task list for this activity task must be specified either as a default for the activity type or through this field.\n\tIf neither this field is set nor a default task list was specified at registration time then a fault will be returned.\n\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "scheduleToStartTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tIf set, specifies the maximum duration the activity task can wait to be assigned to a worker. This\n\t\toverrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n\tA schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field.\n\tIf neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned." + }, + "startToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tIf set, specifies the maximum duration a worker may take to process this activity task. This\n\t\toverrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n\tA start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field.\n\tIf neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned." + }, + "heartbeatTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tIf set, specifies the maximum time before which a worker processing a task of this type must report progress by\n\t\tcalling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n\t\tIf the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored.\n\t\tThis overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + } + }, + "documentation":"

Provides details of the ScheduleActivityTask decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "ScheduleActivityTaskFailedCause":{ + "type":"string", + "enum":[ + "ACTIVITY_TYPE_DEPRECATED", + "ACTIVITY_TYPE_DOES_NOT_EXIST", + "ACTIVITY_ID_ALREADY_IN_USE", + "OPEN_ACTIVITIES_LIMIT_EXCEEDED", + "ACTIVITY_CREATION_RATE_EXCEEDED", + "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", + "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", + "OPERATION_NOT_PERMITTED" + ] + }, + "ScheduleActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityType":{ + "shape":"ActivityType", + "documentation":"

\n The activity type provided in the ScheduleActivityTask decision that failed.\n

" + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

\n The activityId provided in the ScheduleActivityTask decision that failed.\n

" + }, + "cause":{ + "shape":"ScheduleActivityTaskFailedCause", + "documentation":"

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the ScheduleActivityTaskFailed event.\n

" + }, + "SignalExternalWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "signalName" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n\t\tThe workflowId of the workflow execution to be signaled.\n\t\tThis field is required.\n

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n\t\tThe runId of the workflow execution to be signaled.\n

" + }, + "signalName":{ + "shape":"SignalName", + "documentation":"

\n\t\tThe name of the signal.The target workflow execution will use the signal name and\n\t\tinput to process the signal.\n\t\tThis field is required.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n\t\tOptional input to be provided with the signal.The target workflow execution will use the signal name and\n\t\tinput to process the signal.\n

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n\t\tOptional data attached to the event that can be used by the decider in subsequent decision\n\t\ttasks.\n

" + } + }, + "documentation":"

Provides details of the SignalExternalWorkflowExecution decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "SignalExternalWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", + "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "SignalExternalWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n The workflowId of the external workflow execution that the signal was being delivered to.\n

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n The runId of the external workflow execution that the signal was being delivered to.\n

" + }, + "cause":{ + "shape":"SignalExternalWorkflowExecutionFailedCause", + "documentation":"

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n

" + }, + "control":{"shape":"Data"} + }, + "documentation":"

\n Provides details of the SignalExternalWorkflowExecutionFailed event.\n

" + }, + "SignalExternalWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "signalName", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n The workflowId of the external workflow execution.\n

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n The runId of the external workflow execution to send the signal to.\n

" + }, + "signalName":{ + "shape":"SignalName", + "documentation":"

\n The name of the signal.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n Input provided to the signal (if any).\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n

" + } + }, + "documentation":"

\n Provides details of the SignalExternalWorkflowExecutionInitiated event.\n

" + }, + "SignalName":{ + "type":"string", + "min":1, + "max":256 + }, + "SignalWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId", + "signalName" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n The name of the domain containing the workflow execution to signal.\n

" + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n The workflowId of the workflow execution to signal.\n

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n The runId of the workflow execution to signal.\n

" + }, + "signalName":{ + "shape":"SignalName", + "documentation":"

\n The name of the signal. This name must be meaningful to the target workflow.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.\n

" + } + } + }, + "StartChildWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":[ + "workflowType", + "workflowId" + ], + "members":{ + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n\t\tThe type of the workflow execution to be started.\n\t\tThis field is required.\n

" + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n\t\tThe workflowId of the workflow execution.\n\t\tThis field is required.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n\t\tOptional data attached to the event that can be used by the decider in subsequent workflow\n\t\ttasks. This data is not sent to the child workflow execution.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n\t\tThe input to be provided to the workflow execution.\n

" + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tThe total duration for this workflow execution. This overrides\n\t\tthe defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n\t

\n\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n\tAn execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n\tIf neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned." + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n\t\tThe name of the task list to be used for decision tasks of the child workflow execution.\n

\n\tA task list for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n\tIf neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.\n\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tSpecifies the maximum duration of decision tasks for this workflow execution.\n\t\t\tThis parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.\n\t\t

\n\t\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n\t\tA task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n\t\tIf neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned." + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\t\tIf set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated\n\t\t\tby calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\t\t\tThis policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n\t\t\tThe supported child policies are:

\n\t\t\t\n \tA child policy for the workflow execution being started must be specified either as a default registered for its workflow type\n \tor through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.\n \t" + }, + "tagList":{ + "shape":"TagList", + "documentation":"

\n \t\tThe list of tags to associate with the child workflow execution. A maximum\n \t\tof 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions\n \t\tor ListClosedWorkflowExecutions and specifying a TagFilter.\n \t

" + } + }, + "documentation":"

Provides details of the StartChildWorkflowExecution decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "StartChildWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "WORKFLOW_TYPE_DOES_NOT_EXIST", + "WORKFLOW_TYPE_DEPRECATED", + "OPEN_CHILDREN_LIMIT_EXCEEDED", + "OPEN_WORKFLOWS_LIMIT_EXCEEDED", + "CHILD_CREATION_RATE_EXCEEDED", + "WORKFLOW_ALREADY_RUNNING", + "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_CHILD_POLICY_UNDEFINED", + "OPERATION_NOT_PERMITTED" + ] + }, + "StartChildWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowType", + "cause", + "workflowId", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The workflow type provided in the StartChildWorkflowExecution Decision that failed.\n

" + }, + "cause":{ + "shape":"StartChildWorkflowExecutionFailedCause", + "documentation":"

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n The workflowId of the child workflow execution.\n

" + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + }, + "control":{"shape":"Data"} + }, + "documentation":"

\n Provides details of the StartChildWorkflowExecutionFailed event.\n

" + }, + "StartChildWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "workflowType", + "taskList", + "decisionTaskCompletedEventId", + "childPolicy" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n The workflowId of the child workflow execution.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n The type of the child workflow execution.\n

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks. This data is not sent to the activity.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n The inputs provided to the child workflow execution (if any).\n

" + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration,\n it will be timed out and force terminated.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n The name of the task list used for the decision tasks of the child workflow execution.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n The policy to use for the child workflow executions if this execution gets terminated by explicitly calling\n the TerminateWorkflowExecution action or due to an expired timeout.

\n

The supported child policies are:

\n \n " + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n The maximum duration allowed for the decision tasks for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "tagList":{ + "shape":"TagList", + "documentation":"

\n The list of tags to associated with the child workflow execution.\n

" + } + }, + "documentation":"

\n Provides details of the StartChildWorkflowExecutionInitiated event.\n

" + }, + "StartTimerDecisionAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startToFireTimeout" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

\n\t\tThe unique Id of the timer.\n\t\tThis field is required.

\n\t\t

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n\t\tOptional data attached to the event that can be used by the decider in subsequent workflow\n\t\ttasks.\n

" + }, + "startToFireTimeout":{ + "shape":"DurationInSeconds", + "documentation":"

\n\t\tThe duration to wait before firing the timer.\n\t\tThis field is required.\n

\n

The duration is specified in seconds. The valid values are integers greater than or equal to 0.

" + } + }, + "documentation":"

Provides details of the StartTimer decision.

\n

Access Control

\n

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints,\n the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" + }, + "StartTimerFailedCause":{ + "type":"string", + "enum":[ + "TIMER_ID_ALREADY_IN_USE", + "OPEN_TIMERS_LIMIT_EXCEEDED", + "TIMER_CREATION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "StartTimerFailedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

\n The timerId provided in the StartTimer decision that failed.\n

" + }, + "cause":{ + "shape":"StartTimerFailedCause", + "documentation":"

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n \n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartTimer decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the StartTimerFailed event.\n

" + }, + "StartWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId", + "workflowType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n\t\t\tThe name of the domain in which the workflow execution is created.\n\t\t

" + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n\t \t\tThe user defined identifier associated with the workflow execution. You can use this to\n\t \t\tassociate a custom identifier with the workflow execution. You may specify the same\n\t \t\tidentifier if a workflow execution is logically a restart of a previous execution.\n\t \t\tYou cannot have two open workflow executions with the same workflowId at the same time.\n \t\t

\n \t\t

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n\t\t\tThe type of the workflow to start.\n\t\t

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n\t\t\tThe task list to use for the decision tasks generated for this workflow execution.\n\t\t\tThis overrides the defaultTaskList specified when registering the workflow type.\n \t\t

\n\t\tA task list for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n\t\tIf neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.\n \t\t

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n \t\t\tThe input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting.\n \t\t\tThis input is made available to the new workflow execution in the WorkflowExecutionStarted history event.\n \t\t

" + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tThe total duration for this workflow execution. This overrides\n\t\t\tthe defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n\t\t

\n\n\t\t

\n\t\t\tThe duration is specified in seconds. The valid values are integers greater than or equal to 0.\n\t\t\tExceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot \n\t\t\tspecify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run. \n\t\t

\n\n\t\t\n\t\t\tAn execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered.\n\t\t\tIf neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.\n\t\t" + }, + "tagList":{ + "shape":"TagList", + "documentation":"

\n \t\t\tThe list of tags to associate with the workflow execution. You can specify a maximum\n \t\t\tof 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or\n \t\t\tListClosedWorkflowExecutions and specifying a TagFilter.\n \t\t

" + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\t\tSpecifies the maximum duration of decision tasks for this workflow execution.\n\t\t\tThis parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.\n\t\t

\n\n\t\t

\n\t\t\tThe valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.\n\t\t

\n\n\t\tA task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n\t\tIf neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned." + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\t\tIf set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated,\n\t\t\tby calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\t\t\tThis policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n\t\t\tThe supported child policies are:

\n\n\t\t\n\t\tA child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n\t\tIf neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned." + } + } + }, + "Tag":{ + "type":"string", + "min":1, + "max":256 + }, + "TagFilter":{ + "type":"structure", + "required":["tag"], + "members":{ + "tag":{ + "shape":"Tag", + "documentation":"

\n\t\tSpecifies the tag that must be associated with the execution for it to meet the filter criteria.\n\t\tThis field is required.\n

" + } + }, + "documentation":"

\n \t\tUsed to filter the workflow executions in visibility APIs based on a tag.\n

" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":5 + }, + "TaskList":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

\n The name of the task list.\n

" + } + }, + "documentation":"

\n Represents a task list.\n

" + }, + "TaskToken":{ + "type":"string", + "min":1, + "max":1024 + }, + "TerminateReason":{ + "type":"string", + "max":256 + }, + "TerminateWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

\n\t\t\tThe domain of the workflow execution to terminate.\n\t\t

" + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n \t\t\tThe workflowId of the workflow execution to terminate.\n \t\t

" + }, + "runId":{ + "shape":"RunIdOptional", + "documentation":"

\n \t\t\tThe runId of the workflow execution to terminate.\n \t\t

" + }, + "reason":{ + "shape":"TerminateReason", + "documentation":"

\n \t\t\tAn optional descriptive reason for terminating the workflow execution.\n \t\t

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n \t\t\tOptional details for terminating the workflow execution.\n \t\t

" + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\t\tIf set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.\n\t\t\tThis policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.\n\t\t\tThe supported child policies are:

\n\t\t\t\n\t\tA child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n\t\tIf neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned." + } + } + }, + "TimerCanceledEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

\n The unique Id of the timer that was canceled.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelTimer decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the TimerCanceled event.\n

" + }, + "TimerFiredEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

\n The unique Id of the timer that fired.\n

" + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + } + }, + "documentation":"

\n Provides details of the TimerFired event.\n

" + }, + "TimerId":{ + "type":"string", + "min":1, + "max":256 + }, + "TimerStartedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startToFireTimeout", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

\n The unique Id of the timer that was started.\n

" + }, + "control":{ + "shape":"Data", + "documentation":"

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. \n

" + }, + "startToFireTimeout":{ + "shape":"DurationInSeconds", + "documentation":"

\n The duration of time after which the timer will fire.\n

\n

The duration is specified in seconds. The valid values are integers greater than or equal to 0.

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartTimer decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the TimerStarted event.\n

" + }, + "Timestamp":{"type":"timestamp"}, + "Truncated":{"type":"boolean"}, + "TypeAlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\n A description that may help with diagnosing the cause of the fault.\n

" + } + }, + "exception":true, + "documentation":"

\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n

" + }, + "TypeDeprecatedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\n\t\tA description that may help with diagnosing the cause of the fault.\n

" + } + }, + "exception":true, + "documentation":"

\n\t\tReturned when the specified activity or workflow type was already deprecated.\n

" + }, + "UnknownResourceFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\n A description that may help with diagnosing the cause of the fault.\n

" + } + }, + "exception":true, + "documentation":"

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

" + }, + "Version":{ + "type":"string", + "min":1, + "max":64 + }, + "VersionOptional":{ + "type":"string", + "max":64 + }, + "WorkflowExecution":{ + "type":"structure", + "required":[ + "workflowId", + "runId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n \t\tThe user defined identifier associated with the workflow execution.\n

" + }, + "runId":{ + "shape":"RunId", + "documentation":"

\n\t\tA system generated unique identifier for the workflow execution.\n

" + } + }, + "documentation":"

\n\t\tRepresents a workflow execution.\n

" + }, + "WorkflowExecutionAlreadyStartedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\n\t\tA description that may help with diagnosing the cause of the fault.\n

" + } + }, + "exception":true, + "documentation":"

\n \t\tReturned by StartWorkflowExecution when an open execution with the same\n \t\tworkflowId is already running in the specified domain.\n

" + }, + "WorkflowExecutionCancelRequestedCause":{ + "type":"string", + "enum":["CHILD_POLICY_APPLIED"] + }, + "WorkflowExecutionCancelRequestedEventAttributes":{ + "type":"structure", + "members":{ + "externalWorkflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The external workflow execution for which the cancellation was requested.\n

" + }, + "externalInitiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

" + }, + "cause":{ + "shape":"WorkflowExecutionCancelRequestedCause", + "documentation":"

\n If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.\n

" + } + }, + "documentation":"

\n Provides details of the WorkflowExecutionCancelRequested event.\n

" + }, + "WorkflowExecutionCanceledEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "details":{ + "shape":"Data", + "documentation":"

\n\t\tDetails for the cancellation (if any).\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n\t\tThe id of the DecisionTaskCompleted event corresponding to the decision task that\n\t\tresulted in the CancelWorkflowExecution decision for this cancellation request.\n\t\tThis information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n\t\tProvides details of the WorkflowExecutionCanceled event.\n

" + }, + "WorkflowExecutionCompletedEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "result":{ + "shape":"Data", + "documentation":"

\n The result produced by the workflow execution upon successful completion.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the WorkflowExecutionCompleted event.\n

" + }, + "WorkflowExecutionConfiguration":{ + "type":"structure", + "required":[ + "taskStartToCloseTimeout", + "executionStartToCloseTimeout", + "taskList", + "childPolicy" + ], + "members":{ + "taskStartToCloseTimeout":{ + "shape":"DurationInSeconds", + "documentation":"

\n\t\tThe maximum duration allowed for decision tasks for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSeconds", + "documentation":"

\n\t\tThe total duration for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n\t\tThe task list used for the decision tasks generated for this workflow execution.\n

" + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\tThe policy to use for the child workflow executions if this workflow execution is terminated,\n\t\tby calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\t\tThe supported child policies are:

\n\t\t" + } + }, + "documentation":"

\n\t\tThe configuration settings for a workflow execution including timeout values, tasklist etc.\n\t\tThese configuration settings are determined from the defaults\n\t\tspecified when registering the workflow type and those specified when starting the workflow execution.\n\t

" + }, + "WorkflowExecutionContinuedAsNewEventAttributes":{ + "type":"structure", + "required":[ + "decisionTaskCompletedEventId", + "newExecutionRunId", + "taskList", + "childPolicy", + "workflowType" + ], + "members":{ + "input":{ + "shape":"Data", + "documentation":"

\n\t\tThe input provided to the new workflow execution.\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n\t\tThe id of the DecisionTaskCompleted event corresponding to the decision task that\n\t\tresulted in the ContinueAsNewWorkflowExecution decision that started this execution.\n\t\tThis information can be useful for diagnosing problems by tracing back the cause of events.\n

" + }, + "newExecutionRunId":{ + "shape":"RunId", + "documentation":"

\n\t\tThe runId of the new workflow execution.\n

" + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tThe total duration allowed for the new workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "taskList":{"shape":"TaskList"}, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tThe maximum duration of decision tasks for the new workflow execution.\n\t

\n\t

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\tThe policy to use for the child workflow executions of the new execution if it is terminated\n\t\tby calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

\n\n\t\t

The supported child policies are:

\n\t\t" + }, + "tagList":{ + "shape":"TagList", + "documentation":"

\n\t\tThe list of tags associated with the new workflow execution.\n \t

" + }, + "workflowType":{"shape":"WorkflowType"} + }, + "documentation":"

\n\t\tProvides details of the WorkflowExecutionContinuedAsNew event.\n

" + }, + "WorkflowExecutionCount":{ + "type":"structure", + "required":["count"], + "members":{ + "count":{ + "shape":"Count", + "documentation":"

\n\t\tThe number of workflow executions.\n

" + }, + "truncated":{ + "shape":"Truncated", + "documentation":"

\n\t\tIf set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n

" + } + }, + "documentation":"

\n\t\tContains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions\n

" + }, + "WorkflowExecutionDetail":{ + "type":"structure", + "required":[ + "executionInfo", + "executionConfiguration", + "openCounts" + ], + "members":{ + "executionInfo":{ + "shape":"WorkflowExecutionInfo", + "documentation":"

\n\t\tInformation about the workflow execution.\n

" + }, + "executionConfiguration":{ + "shape":"WorkflowExecutionConfiguration", + "documentation":"

\n\t\tThe configuration settings for this workflow execution including timeout values, tasklist etc.\n

" + }, + "openCounts":{ + "shape":"WorkflowExecutionOpenCounts", + "documentation":"

\n\t\tThe number of tasks for this workflow execution. This includes open and closed tasks of all types.\n

" + }, + "latestActivityTaskTimestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the\n\t\tworkflow has not made progress for an unusually long period of time and might require a corrective action.\n

" + }, + "latestExecutionContext":{ + "shape":"Data", + "documentation":"

\n\t\tThe latest executionContext provided by the decider for this workflow execution.\n\t\tA decider can provide an executionContext, which is a free form string, when closing a decision task\n\t\tusing RespondDecisionTaskCompleted.\n

" + } + }, + "documentation":"

\n\t\tContains details about a workflow execution.\n

" + }, + "WorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "reason":{ + "shape":"FailureReason", + "documentation":"

\n The descriptive reason provided for the failure (if any).\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n The details of the failure (if any).\n

" + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the FailWorkflowExecution decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

" + } + }, + "documentation":"

\n Provides details of the WorkflowExecutionFailed event.\n

" + }, + "WorkflowExecutionFilter":{ + "type":"structure", + "required":["workflowId"], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

\n\t\tThe workflowId to pass of match the criteria of this filter.\n

" + } + }, + "documentation":"

\n \t\tUsed to filter the workflow executions in visibility APIs by their\n \t\tworkflowId.\n

" + }, + "WorkflowExecutionInfo":{ + "type":"structure", + "required":[ + "execution", + "workflowType", + "startTimestamp", + "executionStatus" + ], + "members":{ + "execution":{ + "shape":"WorkflowExecution", + "documentation":"

\n\t\tThe workflow execution this information is about.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n\t\tThe type of the workflow execution.\n

" + }, + "startTimestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe time when the execution was started.\n

" + }, + "closeTimestamp":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe time when the workflow execution was closed. Set only if the execution status is CLOSED.\n

" + }, + "executionStatus":{ + "shape":"ExecutionStatus", + "documentation":"

\n\t\tThe current status of the execution.\n

" + }, + "closeStatus":{ + "shape":"CloseStatus", + "documentation":"

\n\t\tIf the execution status is closed then this specifies how the execution was closed:

\n\t\t" + }, + "parent":{ + "shape":"WorkflowExecution", + "documentation":"

\n\t\tIf this workflow execution is a child of another execution then contains\n\t\tthe workflow execution that started this execution.\n

" + }, + "tagList":{ + "shape":"TagList", + "documentation":"

\n\t\tThe list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n\t\tof interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n

" + }, + "cancelRequested":{ + "shape":"Canceled", + "documentation":"

\n\t\tSet to true if a cancellation is requested for this workflow execution.\n

" + } + }, + "documentation":"

\n\t\tContains information about a workflow execution. \n\t\t\n\t\t\n

" + }, + "WorkflowExecutionInfoList":{ + "type":"list", + "member":{"shape":"WorkflowExecutionInfo"} + }, + "WorkflowExecutionInfos":{ + "type":"structure", + "required":["executionInfos"], + "members":{ + "executionInfos":{ + "shape":"WorkflowExecutionInfoList", + "documentation":"

\n\t\tThe list of workflow information structures.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n\t\tThe token of the next page in the result. If set, the results have more than one page. The next\n\t\tpage can be retrieved by repeating the request with this token and all other arguments unchanged.\n

" + } + }, + "documentation":"

\n\t\tContains a paginated list of information about workflow executions.\n

" + }, + "WorkflowExecutionOpenCounts":{ + "type":"structure", + "required":[ + "openActivityTasks", + "openDecisionTasks", + "openTimers", + "openChildWorkflowExecutions" + ], + "members":{ + "openActivityTasks":{ + "shape":"Count", + "documentation":"

\n\t\tThe count of activity tasks whose status is OPEN.\n

" + }, + "openDecisionTasks":{ + "shape":"OpenDecisionTasksCount", + "documentation":"

\n\t\tThe count of decision tasks whose status is OPEN.\n\t\tA workflow execution can have at most one open decision task.\n

" + }, + "openTimers":{ + "shape":"Count", + "documentation":"

\n\t\tThe count of timers started by this workflow execution that have not fired yet.\n

" + }, + "openChildWorkflowExecutions":{ + "shape":"Count", + "documentation":"

\n\t\tThe count of child workflow executions whose status is OPEN.\n

" + } + }, + "documentation":"

\n\t\tContains the counts of open tasks, child workflow executions and timers for a workflow execution.\n

" + }, + "WorkflowExecutionSignaledEventAttributes":{ + "type":"structure", + "required":["signalName"], + "members":{ + "signalName":{ + "shape":"SignalName", + "documentation":"

\n The name of the signal received. The decider can use the signal name and inputs to determine\n how to the process the signal.\n

" + }, + "input":{ + "shape":"Data", + "documentation":"

\n Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine\n how to process the signal.\n

" + }, + "externalWorkflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n The workflow execution that sent the signal. This is set only of the signal was sent by another\n workflow execution.\n

" + }, + "externalInitiatedEventId":{ + "shape":"EventId", + "documentation":"

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflow decision to signal this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event. This field is set only if the signal was initiated by another workflow execution.\n \n

" + } + }, + "documentation":"

\n Provides details of the WorkflowExecutionSignaled event.\n

" + }, + "WorkflowExecutionStartedEventAttributes":{ + "type":"structure", + "required":[ + "childPolicy", + "taskList", + "workflowType" + ], + "members":{ + "input":{ + "shape":"Data", + "documentation":"

\n\t\tThe input provided to the workflow execution (if any).\n

" + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tThe maximum duration for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tThe maximum duration of decision tasks for this workflow type.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\tThe policy to use for the child workflow executions if this workflow execution is terminated,\n\t\tby calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\n\t\tThe supported child policies are:\n\t\t

\n

" + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

\n\t\tThe name of the task list for scheduling the decision tasks for this workflow execution.\n

" + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n\t\tThe workflow type of this execution.\n

" + }, + "tagList":{ + "shape":"TagList", + "documentation":"

\n\t\tThe list of tags associated with this workflow execution. An execution can have up to 5 tags.\n

" + }, + "continuedExecutionRunId":{ + "shape":"RunIdOptional", + "documentation":"

\n\t\tIf this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then\n\t\tit contains the runId of the previous workflow execution that was closed and continued as this execution.\n

" + }, + "parentWorkflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

\n\t\tThe source workflow execution that started this workflow execution. The member is not set if the workflow execution was\n\t\tnot started by a workflow.\n

" + }, + "parentInitiatedEventId":{ + "shape":"EventId", + "documentation":"

\n\t\tThe id of the StartChildWorkflowExecutionInitiated event corresponding to the\n\t\tStartChildWorkflowExecution Decision to start this workflow execution. The source event\n\t\twith this Id can be found in the history of the source workflow execution.\n\t\tThis information can be useful for diagnosing problems by tracing back the chain of events leading\n\t\tup to this event.\n

" + } + }, + "documentation":"

\n\t\tProvides details of WorkflowExecutionStarted event.\n

" + }, + "WorkflowExecutionTerminatedCause":{ + "type":"string", + "enum":[ + "CHILD_POLICY_APPLIED", + "EVENT_LIMIT_EXCEEDED", + "OPERATOR_INITIATED" + ] + }, + "WorkflowExecutionTerminatedEventAttributes":{ + "type":"structure", + "required":["childPolicy"], + "members":{ + "reason":{ + "shape":"TerminateReason", + "documentation":"

\n\t\tThe reason provided for the termination (if any).\n

" + }, + "details":{ + "shape":"Data", + "documentation":"

\n\t\tThe details provided for the termination (if any).\n

" + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\t\tThe policy used for the child workflow executions of this workflow execution.\n\t\t\tThe supported child policies are:

\n\t\t\t" + }, + "cause":{ + "shape":"WorkflowExecutionTerminatedCause", + "documentation":"

\n\t\tIf set, indicates that the workflow execution was automatically terminated, and specifies the cause.\n\t\tThis happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.\n

" + } + }, + "documentation":"

\n\t\tProvides details of the WorkflowExecutionTerminated event.\n

" + }, + "WorkflowExecutionTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "childPolicy" + ], + "members":{ + "timeoutType":{ + "shape":"WorkflowExecutionTimeoutType", + "documentation":"

\n\t\tThe type of timeout that caused this event.\n

" + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\t\tThe policy used for the child workflow executions of this workflow execution.\n\t\t\tThe supported child policies are:\n\t\t\t

\n\t\t

" + } + }, + "documentation":"

\n\t\tProvides details of the WorkflowExecutionTimedOut event.\n

" + }, + "WorkflowExecutionTimeoutType":{ + "type":"string", + "enum":["START_TO_CLOSE"] + }, + "WorkflowId":{ + "type":"string", + "min":1, + "max":256 + }, + "WorkflowType":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

\n\t\tThe name of the workflow type.\n\t\tThis field is required.\n\t\tThe combination of workflow type name and version must be unique with in a domain.\n

" + }, + "version":{ + "shape":"Version", + "documentation":"

\n\t\tThe version of the workflow type.\n\t\tThis field is required.\n\t\tThe combination of workflow type name and version must be unique with in a domain.\n

" + } + }, + "documentation":"

\n\t\tRepresents a workflow type.\n

" + }, + "WorkflowTypeConfiguration":{ + "type":"structure", + "members":{ + "defaultTaskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tThe optional default maximum duration, specified when registering the workflow type, that a decision task for executions\n\t\tof this workflow type might take before returning completion or\n\t\tfailure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If\n\t\tthe decider eventually reports a completion or failure, it is ignored.\n\t\tThis default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n\t\tthe StartChildWorkflowExecution Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultExecutionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

\n\t\tThe optional default maximum duration, specified when registering the workflow type, for executions of this workflow type.\n\t\tThis default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n\t\tthe StartChildWorkflowExecution Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

" + }, + "defaultTaskList":{ + "shape":"TaskList", + "documentation":"

\n\t\tThe optional default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.\n\t\tThis default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n\t\tthe StartChildWorkflowExecution Decision.\n

" + }, + "defaultChildPolicy":{ + "shape":"ChildPolicy", + "documentation":"

\n\t\tThe optional default policy to use for the child workflow executions when a workflow execution of this type is terminated,\n\t\tby calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\t\tThis default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n\t\tthe StartChildWorkflowExecution Decision.\n\t\tThe supported child policies are:

\n\t\t" + } + }, + "documentation":"

\n\t\tThe configuration settings of a workflow type.\n

" + }, + "WorkflowTypeDetail":{ + "type":"structure", + "required":[ + "typeInfo", + "configuration" + ], + "members":{ + "typeInfo":{ + "shape":"WorkflowTypeInfo", + "documentation":"

\n\t\tGeneral information about the workflow type.\n\t\t

\n\n\t\t

\n\t\t\tThe status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.\n\t\t

\n\t\t" + }, + "configuration":{ + "shape":"WorkflowTypeConfiguration", + "documentation":"

\n\t\tConfiguration settings of the workflow type registered through RegisterWorkflowType\n

" + } + }, + "documentation":"

\n\t\tContains details about a workflow type.\n

" + }, + "WorkflowTypeFilter":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

\n\t\tName of the workflow type.\n\t\tThis field is required.\n

" + }, + "version":{ + "shape":"VersionOptional", + "documentation":"

\n\t\tVersion of the workflow type.\n

" + } + }, + "documentation":"

\n \t\tUsed to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by\n \t\teach returned result.\n

" + }, + "WorkflowTypeInfo":{ + "type":"structure", + "required":[ + "workflowType", + "status", + "creationDate" + ], + "members":{ + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

\n\t\tThe workflow type this information is about.\n

" + }, + "status":{ + "shape":"RegistrationStatus", + "documentation":"

\n\t\tThe current status of the workflow type.\n

" + }, + "description":{ + "shape":"Description", + "documentation":"

\n\t\tThe description of the type registered through RegisterWorkflowType.\n

" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

\n\t\tThe date when this type was registered.\n

" + }, + "deprecationDate":{ + "shape":"Timestamp", + "documentation":"

\n\t\tIf the type is in deprecated state, then it is set to the date when the type was deprecated.\n

" + } + }, + "documentation":"

\n\t\tContains information about a workflow type.\n

" + }, + "WorkflowTypeInfoList":{ + "type":"list", + "member":{"shape":"WorkflowTypeInfo"} + }, + "WorkflowTypeInfos":{ + "type":"structure", + "required":["typeInfos"], + "members":{ + "typeInfos":{ + "shape":"WorkflowTypeInfoList", + "documentation":"

\n\t\tThe list of workflow type information.\n

" + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

\n\t\tThe token for the next page of type information. If set then the list consists of more than one page.\n\t\tYou can retrieve the next page by repeating the request (that returned the structure) with the this token and all other arguments unchanged.\n

" + } + }, + "documentation":"

\n\t\tContains a paginated list of information structures about workflow types.\n

" + } + } +} diff --git a/apis/swf-2012-01-25.paginators.json b/apis/swf-2012-01-25.paginators.json new file mode 100644 index 0000000000..892ee38b5a --- /dev/null +++ b/apis/swf-2012-01-25.paginators.json @@ -0,0 +1,46 @@ +{ + "pagination": { + "GetWorkflowExecutionHistory": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "events" + }, + "ListActivityTypes": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "typeInfos" + }, + "ListClosedWorkflowExecutions": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "executionInfos" + }, + "ListDomains": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "domainInfos" + }, + "ListOpenWorkflowExecutions": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "executionInfos" + }, + "ListWorkflowTypes": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "typeInfos" + }, + "PollForDecisionTask": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "events" + } + } +} diff --git a/dist-tools/strategies/default.js b/dist-tools/strategies/default.js index 5cec8a7b4c..853dea2a64 100644 --- a/dist-tools/strategies/default.js +++ b/dist-tools/strategies/default.js @@ -10,7 +10,7 @@ function DefaultStrategy(builder) { this.minifyOptions = this.builder.options.minifyOptions || {}; this.minifyOptions.fromString = true; this.AWS = require(this.libPath + '/lib/aws'); - this.apis = require('aws-sdk-apis'); + this.apis = require(this.libPath + '/lib/api_loader'); this.license = [ '// AWS SDK for JavaScript v' + this.AWS.VERSION, '// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.', diff --git a/doc-src/templates/api-versions/plugin.rb b/doc-src/templates/api-versions/plugin.rb index 0b1461a81f..c2f8450a8f 100644 --- a/doc-src/templates/api-versions/plugin.rb +++ b/doc-src/templates/api-versions/plugin.rb @@ -2,7 +2,7 @@ require_relative './model_documentor' $APIS_DIR = File.expand_path(File.dirname(__FILE__) + - "/../../../vendor/apis/apis") + "/../../../apis") $API_FILE_MATCH = /(?:^|\/)([^\/]+?)-(\d+-\d+-\d+)\.full\.json$/ YARD::Tags::Library.define_tag 'Service', :service @@ -217,7 +217,7 @@ def load_model(file) end def class_info_for(prefix) - @info ||= JSON.parse(File.read(File.join($APIS_DIR, '../metadata.json'))) + @info ||= JSON.parse(File.read(File.join($APIS_DIR, 'metadata.json'))) @info.each do |identifier, info| iprefix = info['prefix'] || identifier if prefix == iprefix diff --git a/lib/api_loader.js b/lib/api_loader.js new file mode 100644 index 0000000000..85c5c64179 --- /dev/null +++ b/lib/api_loader.js @@ -0,0 +1,131 @@ +var fs = require('fs'); +var path = require('path'); + +var apiRoot = path.join(__dirname, '..', 'apis'); +var serviceMap = null; +var serviceIdentifiers = []; +var serviceNames = []; + +function buildServiceMap() { + if (serviceMap !== null) return; + + // load info file for API metadata + var infoFile = path.join(apiRoot, 'metadata.json'); + serviceMap = JSON.parse(fs.readFileSync(infoFile).toString()); + + var prefixMap = {}; + Object.keys(serviceMap).forEach(function(identifier) { + serviceMap[identifier].prefix = serviceMap[identifier].prefix || identifier; + prefixMap[serviceMap[identifier].prefix] = identifier; + }); + + fs.readdirSync(apiRoot).forEach(function (file) { + var match = file.match(/^(.+?)-(\d+-\d+-\d+)\.api\.json$/); + if (match) { + var id = prefixMap[match[1]], version = match[2]; + if (serviceMap[id]) { + serviceMap[id].versions = serviceMap[id].versions || []; + serviceMap[id].versions.push(version); + } + } + }); + + Object.keys(serviceMap).forEach(function(identifier) { + serviceMap[identifier].versions = serviceMap[identifier].versions.sort(); + serviceIdentifiers.push(identifier); + serviceNames.push(serviceMap[identifier].name); + }); +} + +function getServices() { + buildServiceMap(); + return serviceIdentifiers; +} + +function getServiceNames() { + buildServiceMap(); + return serviceNames; +} + +function serviceVersions(svc) { + buildServiceMap(); + svc = serviceIdentifier(svc); + return serviceMap[svc] ? serviceMap[svc].versions : null; +} + +function serviceName(svc) { + buildServiceMap(); + svc = serviceIdentifier(svc); + return serviceMap[svc] ? serviceMap[svc].name : null; +} + +function serviceFile(svc, version) { + buildServiceMap(); + svc = serviceIdentifier(svc); + if (!serviceMap[svc]) return null; + + var prefix = serviceMap[svc].prefix || svc; + return apiRoot + '/' + prefix.toLowerCase() + '-' + version + '.api.json'; +} + +function paginatorsFile(svc, version) { + buildServiceMap(); + svc = serviceIdentifier(svc); + if (!serviceMap[svc]) return null; + + var prefix = serviceMap[svc].prefix || svc; + return apiRoot + '/' + prefix + '-' + version + '.paginators.json'; +} + +function waitersFile(svc, version) { + buildServiceMap(); + svc = serviceIdentifier(svc); + if (!serviceMap[svc]) return null; + + var prefix = serviceMap[svc].prefix || svc; + return apiRoot + '/' + prefix + '-' + version + '.waiters.json'; +} + +function load(svc, version) { + buildServiceMap(); + svc = serviceIdentifier(svc); + if (version === 'latest') version = null; + version = version || serviceMap[svc].versions[serviceMap[svc].versions.length - 1]; + if (!serviceMap[svc]) return null; + + var api = JSON.parse(fs.readFileSync(serviceFile(svc, version))); + + // Try to load paginators + if (fs.existsSync(paginatorsFile(svc, version))) { + var paginators = JSON.parse(fs.readFileSync(paginatorsFile(svc, version))); + api.paginators = paginators.pagination; + } + + // Try to load waiters + if (fs.existsSync(waitersFile(svc, version))) { + var waiters = JSON.parse(fs.readFileSync(waitersFile(svc, version))); + api.waiters = waiters.waiters; + } + + return api; +} + +function serviceIdentifier(svc) { + return svc.toLowerCase(); +} + +module.exports = { + serviceVersions: serviceVersions, + serviceName: serviceName, + serviceIdentifier: serviceIdentifier, + serviceFile: serviceFile, + load: load +}; + +Object.defineProperty(module.exports, 'services', { + enumerable: true, get: getServices +}); + +Object.defineProperty(module.exports, 'serviceNames', { + enumerable: true, get: getServiceNames +}); diff --git a/lib/aws.js b/lib/aws.js index 30b152af7b..d293b4d359 100644 --- a/lib/aws.js +++ b/lib/aws.js @@ -1,6 +1,9 @@ var AWS = require('./core'); module.exports = AWS; +// Use default API loader function +AWS.apiLoader = require('./api_loader').load; + // Load the xml2js XML parser AWS.XML.Parser = require('./xml/node_parser'); diff --git a/lib/core.js b/lib/core.js index decdd61324..8d6c01306b 100644 --- a/lib/core.js +++ b/lib/core.js @@ -62,7 +62,12 @@ AWS.util.update(AWS, { ResourceWaiter: require('./model/resource_waiter') }, - util: require('./util') + util: require('./util'), + + /** + * @api private + */ + apiLoader: function() { throw new Error('No API loader set'); } }); require('./service'); diff --git a/lib/service.js b/lib/service.js index 7d317e721d..d47e241759 100644 --- a/lib/service.js +++ b/lib/service.js @@ -460,8 +460,7 @@ AWS.util.update(AWS.Service, { setApi(apiConfig); } else { try { - var apis = AWS.util.nodeRequire('aws-sdk-apis'); - setApi(apis.load(superclass.serviceIdentifier, version)); + setApi(AWS.apiLoader(superclass.serviceIdentifier, version)); } catch (err) { throw AWS.util.error(err, { message: 'Could not find API configuration ' + diff --git a/lib/services.js b/lib/services.js index bbb7f5a930..03d1b7cbab 100644 --- a/lib/services.js +++ b/lib/services.js @@ -1,7 +1,7 @@ var fs = require('fs'); var path = require('path'); var AWS = require('./core'); -var apis = require('aws-sdk-apis'); +var apis = require('./api_loader'); // define services using map apis.services.forEach(function(identifier) { diff --git a/package.json b/package.json index c9d657181e..25623ad799 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,6 @@ "coveralls": "2.x" }, "dependencies": { - "aws-sdk-apis": ">=3.1.0 <4.0.0", "xml2js": "0.2.6", "xmlbuilder": "0.4.2" }, diff --git a/scripts/lib/translator.js b/scripts/lib/translator.js new file mode 100644 index 0000000000..c178c63c90 --- /dev/null +++ b/scripts/lib/translator.js @@ -0,0 +1,153 @@ +/* A couple of utility methods */ + +function each(obj, iter) { + for (var key in obj) { + if (obj.hasOwnProperty(key)) iter(key, obj[key]); + } +} + +function nextString(str) { + return 'S' + (parseInt(str.substr(1), 36) + 1).toString(36); +} + +/* End utility methods */ + +function Translator(api, options) { + var origLength = JSON.stringify(api, null, 2).length; + var debugInfo = {flattened: {}, pruned: {}}; + var shapeName = 'S0'; + var shapeNameMap = {}; + var visitedShapes = {}; + + function logResults() { + console.log('** Generated', api.metadata.endpointPrefix + '-' + + api.metadata.apiVersion +'.api.json' + + (process.env.DEBUG ? ':' : '')); + + if (process.env.DEBUG) { + var pruned = Object.keys(debugInfo.pruned); + var flattened = Object.keys(debugInfo.flattened); + var newLength = JSON.stringify(api, null, 2).length; + console.log('- Pruned Shapes:', pruned.length); + console.log('- Flattened Shapes:', flattened.length); + console.log('- Remaining Shapes:', Object.keys(api.shapes).length); + console.log('- Original Size:', origLength / 1024.0, 'kb'); + console.log('- Minified Size:', newLength / 1024.0, 'kb'); + console.log('- Size Saving:', (origLength - newLength) / 1024.0, 'kb'); + console.log(''); + } + } + + function deleteTraits(obj) { + if (!options.documentation) { + delete obj.documentation; + delete obj.documentationUrl; + delete obj.errors; + delete obj.min; + delete obj.max; + delete obj.pattern; + delete obj['enum']; + delete obj.box; + } + } + + function trackShapeDeclaration(ref) { + if (ref.shape && !shapeNameMap[ref.shape]) { + // found a shape declaration we have not yet visited. + // assign a new generated name in the shapeNameMap & visit it + var oldShapeName = ref.shape; + ref.shape = shapeName = nextString(shapeName); + + visitedShapes[shapeName] = api.shapes[oldShapeName]; + shapeNameMap[oldShapeName] = {name: shapeName, refs: [ref]}; + + traverseShapeRef(api.shapes[oldShapeName]); + } else if (ref.shape && shapeNameMap[ref.shape]) { + // we visited this shape before. keep track of this ref and rename + // the referenced declaration to the generated name + var map = shapeNameMap[ref.shape]; + map.refs.push(ref); + ref.shape = map.name; + } + } + + function pruneShapes() { + // prune shapes visited only once or only have type specifiers + each(shapeNameMap, function(name, map) { + if (Object.keys(visitedShapes[map.name]).join() === 'type' && + ['structure','map','list'].indexOf(visitedShapes[map.name].type) < 0) { + // flatten out the shape (only a scalar type property is on the shape) + for (var i = 0; i < map.refs.length; i++) { + var ref = map.refs[i]; + debugInfo.flattened[name] = true; + delete ref.shape; + ref.type = visitedShapes[map.name].type; + + // string type is default, don't need to specify this + if (ref.type === 'string') delete ref.type; + } + + // we flattened all refs, we can prune the shape too + delete visitedShapes[map.name]; + debugInfo.pruned[name] = true; + } else if (map.refs.length === 1) { // only visited once + // merge shape data onto ref + var shape = visitedShapes[map.name]; + + for (var i = 0; i < map.refs.length; i++) { + delete map.refs[i].shape; + for (var prop in shape) { + if (shape.hasOwnProperty(prop)) map.refs[i][prop] = shape[prop]; + } + } + + // delete the visited shape + delete visitedShapes[map.name]; + debugInfo.pruned[name] = true; + } + }); + } + + function traverseShapeRef(ref) { + if (!ref) return; + + deleteTraits(ref); + + traverseShapeRef(ref.key); // for maps + traverseShapeRef(ref.value); // for maps + traverseShapeRef(ref.member); // for lists + + // for structures + each(ref.members || {}, function(key, value) { traverseShapeRef(value); }); + + // resolve shape declarations + trackShapeDeclaration(ref); + } + + function traverseOperation(op) { + deleteTraits(op); + + delete op.name; + if (op.http) { + if (op.http.method === 'POST') delete op.http.method; + if (op.http.requestUri === '/') delete op.http.requestUri; + if (Object.keys(op.http).length === 0) delete op.http; + } + + traverseShapeRef(op.input); + traverseShapeRef(op.output); + } + + function traverseApi() { + deleteTraits(api); + each(api.operations, function(name, op) { traverseOperation(op); }); + api.shapes = visitedShapes; + } + + traverseApi(); + pruneShapes(); + logResults(); + return api; +} + +module.exports = Translator; diff --git a/scripts/translate-api b/scripts/translate-api new file mode 100755 index 0000000000..2f72dac2aa --- /dev/null +++ b/scripts/translate-api @@ -0,0 +1,19 @@ +#!/usr/bin/env node + +var fs = require('fs'); +var Translator = require('./lib/translator'); +var util = require('util'); + +var basePath = __dirname + '/../apis/'; +var paths = fs.readdirSync(basePath); +var modelName = process.argv[2] || ''; + +paths.forEach(function (path) { + if (path.match(new RegExp(modelName + ".+\\.full\\.json$"))) { + var opath = path.replace(/\.full\.json$/, '.api.json'); + var data = JSON.parse(fs.readFileSync(basePath + path).toString()); + var translated = new Translator(data, {documentation: false}); + var json = JSON.stringify(translated, null, ' '); + fs.writeFileSync(basePath + opath, json); + } +}); diff --git a/tasks/apis.rake b/tasks/apis.rake index 0ed8448f67..a0241e275b 100644 --- a/tasks/apis.rake +++ b/tasks/apis.rake @@ -12,7 +12,7 @@ end def add_tasks(service, config) klass = config['name'] prefix = config['prefix'] || service - files = Dir["vendor/apis/apis/#{prefix}*.full.json"] + files = Dir["apis/#{prefix}*.full.json"] api = JSON.parse(File.read(files[0]), :max_nesting => false) version = api['metadata']['apiVersion'] service_full_name = api['metadata']['serviceFullName'] @@ -23,7 +23,7 @@ def add_tasks(service, config) namespace(service) do task(:api) do verbose(false) do - sh "#{root}/vendor/apis/scripts/translate-api #{prefix}" + sh "#{root}/scripts/translate-api #{prefix}" end end @@ -103,8 +103,8 @@ end desc 'Builds the API for each service.' task :api => 'api:all' -if File.exists?("#{root}/vendor/apis/metadata.json") - service_map = JSON.parse(File.read('vendor/apis/metadata.json')) +if File.exists?("#{root}/apis/metadata.json") + service_map = JSON.parse(File.read('apis/metadata.json')) service_map.each do |service, config| add_tasks(service, config) end diff --git a/tasks/browser.rake b/tasks/browser.rake index 531abd2d67..250dd3ddea 100644 --- a/tasks/browser.rake +++ b/tasks/browser.rake @@ -61,7 +61,6 @@ namespace :browser do mkdir_p(root) mkdir_p("#{root}/node_modules") cp_r "lib", root - cp_r "node_modules/aws-sdk-apis", "#{root}/node_modules/aws-sdk-apis" cp_r "node_modules/xmlbuilder", "#{root}/node_modules/xmlbuilder" cp_r "node_modules/xml2js", "#{root}/node_modules/xml2js" Dir.chdir("vendor/dist-server") do