dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

New upstream version 1.4.70

Browse source
This commit is contained in:
TANIGUCHI Takaki 2016-11-10 11:24:10 +09:00
parent f90a4166da
commit 2519667221
21 changed files with 2639 additions and 140 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
PKG-INFO
View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.4.64
Version: 1.4.70
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

2
botocore.egg-info/PKG-INFO
View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.4.64
Version: 1.4.70
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

3
botocore.egg-info/SOURCES.txt
View file

@ -47,6 +47,7 @@ botocore/data/application-autoscaling/2016-02-06/paginators-1.json
botocore/data/application-autoscaling/2016-02-06/service-2.json
botocore/data/autoscaling/2011-01-01/paginators-1.json
botocore/data/autoscaling/2011-01-01/service-2.json
botocore/data/budgets/2016-10-20/service-2.json
botocore/data/cloudformation/2010-05-15/paginators-1.json
botocore/data/cloudformation/2010-05-15/service-2.json
botocore/data/cloudformation/2010-05-15/waiters-2.json
@ -218,6 +219,7 @@ botocore/data/servicecatalog/2015-12-10/service-2.json
botocore/data/ses/2010-12-01/paginators-1.json
botocore/data/ses/2010-12-01/service-2.json
botocore/data/ses/2010-12-01/waiters-2.json
botocore/data/sms/2016-10-24/service-2.json
botocore/data/snowball/2016-06-30/service-2.json
botocore/data/sns/2010-03-31/paginators-1.json
botocore/data/sns/2010-03-31/service-2.json
@ -412,6 +414,7 @@ tests/functional/test_alias.py
tests/functional/test_apigateway.py
tests/functional/test_client_class_names.py
tests/functional/test_client_metadata.py
tests/functional/test_cloudformation.py
tests/functional/test_cloudsearchdomain.py
tests/functional/test_credentials.py
tests/functional/test_iot_data.py

2
botocore/__init__.py
View file

@ -16,7 +16,7 @@ import os
import re
import logging
__version__ = '1.4.64'
__version__ = '1.4.70'
class NullHandler(logging.Handler):

96
botocore/data/autoscaling/2011-01-01/service-2.json
View file

@ -19,7 +19,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic load balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html\">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic load balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-instance-asg.html\">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"AttachLoadBalancerTargetGroups":{
"name":"AttachLoadBalancerTargetGroups",
@ -35,7 +35,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Attaches one or more target groups to the specified Auto Scaling group.</p> <p>To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use <a>DetachLoadBalancerTargetGroups</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Attaches one or more target groups to the specified Auto Scaling group.</p> <p>To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use <a>DetachLoadBalancerTargetGroups</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"AttachLoadBalancers":{
"name":"AttachLoadBalancers",
@ -51,7 +51,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Attaches one or more Classic load balancers to the specified Auto Scaling group.</p> <p>To attach an Application load balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Attaches one or more Classic load balancers to the specified Auto Scaling group.</p> <p>To attach an Application load balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"CompleteLifecycleAction":{
"name":"CompleteLifecycleAction",
@ -67,7 +67,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Completes the lifecycle action for the specified token or instance with the specified result.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p> <b>If you finish before the timeout period ends, complete the lifecycle action.</b> </p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Completes the lifecycle action for the specified token or instance with the specified result.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p> <b>If you finish before the timeout period ends, complete the lifecycle action.</b> </p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"CreateAutoScalingGroup":{
"name":"CreateAutoScalingGroup",
@ -81,7 +81,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"CreateLaunchConfiguration":{
"name":"CreateLaunchConfiguration",
@ -95,7 +95,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"CreateOrUpdateTags":{
"name":"CreateOrUpdateTags",
@ -109,7 +109,7 @@
{"shape":"AlreadyExistsFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates tags for the specified Auto Scaling group.</p> <p>When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates or updates tags for the specified Auto Scaling group.</p> <p>When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"DeleteAutoScalingGroup":{
"name":"DeleteAutoScalingGroup",
@ -505,7 +505,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic load balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic load balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"DetachLoadBalancerTargetGroups":{
"name":"DetachLoadBalancerTargetGroups",
@ -561,7 +561,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Enables group metrics for the specified Auto Scaling group. For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/userguide/as-instance-monitoring.html\">Monitoring Your Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Enables group metrics for the specified Auto Scaling group. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html\">Monitoring Your Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"EnterStandby":{
"name":"EnterStandby",
@ -577,7 +577,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Moves the specified instances into <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Moves the specified instances into <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"ExecutePolicy":{
"name":"ExecutePolicy",
@ -606,7 +606,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Moves the specified instances out of <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Moves the specified instances out of <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"PutLifecycleHook":{
"name":"PutLifecycleHook",
@ -623,7 +623,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling Group.</p> <p>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.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling Group.</p> <p>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.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"PutNotificationConfiguration":{
"name":"PutNotificationConfiguration",
@ -636,7 +636,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.</p> <p>This configuration overwrites any existing configuration.</p> <p>For more information see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html\">Getting SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.</p> <p>This configuration overwrites any existing configuration.</p> <p>For more information see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/ASGettingNotifications.html\">Getting SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
@ -667,7 +667,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>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.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html\">Scheduled Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>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.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/schedule_time.html\">Scheduled Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"RecordLifecycleActionHeartbeat":{
"name":"RecordLifecycleActionHeartbeat",
@ -683,7 +683,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p> <b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b> </p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p> <b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b> </p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"ResumeProcesses":{
"name":"ResumeProcesses",
@ -696,7 +696,7 @@
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"SetDesiredCapacity":{
"name":"SetDesiredCapacity",
@ -709,7 +709,7 @@
{"shape":"ScalingActivityInProgressFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Sets the size of the specified Auto Scaling group.</p> <p>For more information about desired capacity, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/WhatIsAutoScaling.html\">What Is Auto Scaling?</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Sets the size of the specified Auto Scaling group.</p> <p>For more information about desired capacity, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/WhatIsAutoScaling.html\">What Is Auto Scaling?</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"SetInstanceHealth":{
"name":"SetInstanceHealth",
@ -721,7 +721,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Sets the health status of the specified instance.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Sets the health status of the specified instance.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"SetInstanceProtection":{
"name":"SetInstanceProtection",
@ -738,7 +738,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Updates the instance protection settings of the specified instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html#instance-protection\">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Updates the instance protection settings of the specified instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"SuspendProcesses":{
"name":"SuspendProcesses",
@ -751,7 +751,7 @@
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.</p> <p>Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly.</p> <p>To resume processes that have been suspended, use <a>ResumeProcesses</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.</p> <p>Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly.</p> <p>To resume processes that have been suspended, use <a>ResumeProcesses</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"TerminateInstanceInAutoScalingGroup":{
"name":"TerminateInstanceInAutoScalingGroup",
@ -1162,7 +1162,7 @@
},
"LifecycleState":{
"shape":"XmlStringMaxLen32",
"documentation":"<p>The lifecycle state for the instance. For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The lifecycle state for the instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"HealthStatus":{
"shape":"XmlStringMaxLen32",
@ -1310,7 +1310,7 @@
},
"InstanceId":{
"shape":"XmlStringMaxLen19",
"documentation":"<p>The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.</p> <p>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.</p> <p>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
@ -1326,7 +1326,7 @@
},
"DefaultCooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"AvailabilityZones":{
"shape":"AvailabilityZones",
@ -1334,7 +1334,7 @@
},
"LoadBalancerNames":{
"shape":"LoadBalancerNames",
"documentation":"<p>One or more Classic load balancers. To specify an Application load balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SetUpASLBApp.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>One or more Classic load balancers. To specify an Application load balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"TargetGroupARNs":{
"shape":"TargetGroupARNs",
@ -1342,11 +1342,11 @@
},
"HealthCheckType":{
"shape":"XmlStringMaxLen32",
"documentation":"<p>The service to use for the health checks. The valid values are <code>EC2</code> and <code>ELB</code>.</p> <p>By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The service to use for the health checks. The valid values are <code>EC2</code> and <code>ELB</code>.</p> <p>By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"HealthCheckGracePeriod":{
"shape":"HealthCheckGracePeriod",
"documentation":"<p>The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.</p> <p>This parameter is required if you are adding an <code>ELB</code> health check.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.</p> <p>This parameter is required if you are adding an <code>ELB</code> health check.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
@ -1354,11 +1354,11 @@
},
"VPCZoneIdentifier":{
"shape":"XmlStringMaxLen2047",
"documentation":"<p>A comma-separated list of subnet identifiers for your virtual private cloud (VPC).</p> <p>If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>A comma-separated list of subnet identifiers for your virtual private cloud (VPC).</p> <p>If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"TerminationPolicies":{
"shape":"TerminationPolicies",
"documentation":"<p>One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"NewInstancesProtectedFromScaleIn":{
"shape":"InstanceProtected",
@ -1366,7 +1366,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>One or more tags.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>One or more tags.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
}
},
"documentation":"<p>Contains the parameters for CreateAutoScalingGroup.</p>"
@ -1405,7 +1405,7 @@
},
"InstanceId":{
"shape":"XmlStringMaxLen19",
"documentation":"<p>The ID of the instance to use to create the launch configuration.</p> <p>The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The ID of the instance to use to create the launch configuration.</p> <p>The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"InstanceType":{
"shape":"XmlStringMaxLen255",
@ -1429,11 +1429,11 @@
},
"SpotPrice":{
"shape":"SpotPrice",
"documentation":"<p>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, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US-SpotInstances.html\">Launching Spot Instances in Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>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, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/US-SpotInstances.html\">Launching Spot Instances in Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"IamInstanceProfile":{
"shape":"XmlStringMaxLen1600",
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</p> <p>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 EC2 instances to securely access other AWS resources. For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-iam-role.html\">Launch Auto Scaling Instances with an IAM Role</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</p> <p>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 EC2 instances to securely access other AWS resources. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/us-iam-role.html\">Launch Auto Scaling Instances with an IAM Role</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"EbsOptimized":{
"shape":"EbsOptimized",
@ -1441,11 +1441,11 @@
},
"AssociatePublicIpAddress":{
"shape":"AssociatePublicIpAddress",
"documentation":"<p>Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>Default: If the instance is launched into a default subnet, the default is <code>true</code>. If the instance is launched into a nondefault subnet, the default is <code>false</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html\">Supported Platforms</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>Default: If the instance is launched into a default subnet, the default is <code>true</code>. If the instance is launched into a nondefault subnet, the default is <code>false</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html\">Supported Platforms</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
},
"PlacementTenancy":{
"shape":"XmlStringMaxLen64",
"documentation":"<p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC.</p> <p>You must set the value of this parameter to <code>dedicated</code> if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to <code>default</code>).</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>"
"documentation":"<p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC.</p> <p>You must set the value of this parameter to <code>dedicated</code> if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to <code>default</code>).</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>"
}
},
"documentation":"<p>Contains the parameters for CreateLaunchConfiguration.</p>"
@ -2087,7 +2087,7 @@
},
"HonorCooldown":{
"shape":"HonorCooldown",
"documentation":"<p>If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.</p> <p>This parameter is not supported if the policy type is <code>StepScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.</p> <p>This parameter is not supported if the policy type is <code>StepScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"MetricValue":{
"shape":"MetricScale",
@ -2400,14 +2400,14 @@
},
"GlobalTimeout":{
"shape":"GlobalTimeout",
"documentation":"<p>The maximum time, in seconds, that an instance can remain in a <code>Pending:Wait</code> or <code>Terminating:Wait</code> state. The default is 172800 seconds (48 hours).</p>"
"documentation":"<p>The maximum time, in seconds, that an instance can remain in a <code>Pending:Wait</code> or <code>Terminating:Wait</code> state. The maximum is 172800 seconds (48 hours) or 100 times <code>HeartbeatTimeout</code>, whichever is smaller.</p>"
},
"DefaultResult":{
"shape":"LifecycleActionResult",
"documentation":"<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>"
}
},
"documentation":"<p>Describes a lifecycle hook, which 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:</p> <ul> <li> <p>Pause the instance after it launches, but before it is put into service</p> </li> <li> <p>Pause the instance as it terminates, but before it is fully terminated</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a lifecycle hook, which 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:</p> <ul> <li> <p>Pause the instance after it launches, but before it is put into service</p> </li> <li> <p>Pause the instance as it terminates, but before it is fully terminated</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"LifecycleHookNames":{
"type":"list",
@ -2611,7 +2611,7 @@
"documentation":"<p>One of the following processes:</p> <ul> <li> <p> <code>Launch</code> </p> </li> <li> <p> <code>Terminate</code> </p> </li> <li> <p> <code>AddToLoadBalancer</code> </p> </li> <li> <p> <code>AlarmNotification</code> </p> </li> <li> <p> <code>AZRebalance</code> </p> </li> <li> <p> <code>HealthCheck</code> </p> </li> <li> <p> <code>ReplaceUnhealthy</code> </p> </li> <li> <p> <code>ScheduledActions</code> </p> </li> </ul>"
}
},
"documentation":"<p>Describes a process type.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html#process-types\">Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a process type.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html#process-types\">Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"Processes":{
"type":"list",
@ -2661,7 +2661,7 @@
},
"NotificationTargetARN":{
"shape":"NotificationTargetResourceName",
"documentation":"<p>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 target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.</p> <p>The notification messages sent to the target include the following information:</p> <ul> <li> <p> <b>AutoScalingGroupName</b>. The name of the Auto Scaling group.</p> </li> <li> <p> <b>AccountId</b>. The AWS account ID.</p> </li> <li> <p> <b>LifecycleTransition</b>. The lifecycle hook type.</p> </li> <li> <p> <b>LifecycleActionToken</b>. The lifecycle action token.</p> </li> <li> <p> <b>EC2InstanceId</b>. The EC2 instance ID.</p> </li> <li> <p> <b>LifecycleHookName</b>. The name of the lifecycle hook.</p> </li> <li> <p> <b>NotificationMetadata</b>. User-defined information.</p> </li> </ul> <p>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.</p> <p>When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: <code>\"Event\": \"autoscaling:TEST_NOTIFICATION\"</code>.</p>"
"documentation":"<p>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 target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.</p> <p>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.</p> <p>When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: <code>\"Event\": \"autoscaling:TEST_NOTIFICATION\"</code>.</p>"
},
"NotificationMetadata":{
"shape":"XmlStringMaxLen1023",
@ -2723,7 +2723,7 @@
},
"AdjustmentType":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The adjustment type. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The adjustment type. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"MinAdjustmentStep":{
"shape":"MinAdjustmentStep",
@ -2739,7 +2739,7 @@
},
"Cooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.</p> <p>This parameter is not supported unless the policy type is <code>SimpleScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.</p> <p>This parameter is not supported unless the policy type is <code>SimpleScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"MetricAggregationType":{
"shape":"XmlStringMaxLen32",
@ -2777,15 +2777,15 @@
},
"StartTime":{
"shape":"TimestampType",
"documentation":"<p>The time for this action to start, in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only (for example, <code>2014-06-01T00:00:00Z</code>).</p> <p>If you try to schedule your action in the past, Auto Scaling returns an error message.</p> <p>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action starts and stops.</p>"
"documentation":"<p>The time for this action to start, in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only (for example, <code>2014-06-01T00:00:00Z</code>).</p> <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.</p> <p>If you try to schedule your action in the past, Auto Scaling returns an error message.</p>"
},
"EndTime":{
"shape":"TimestampType",
"documentation":"<p>The time for this action to end.</p>"
"documentation":"<p>The time for the recurring schedule to end. Auto Scaling does not perform the action after this time.</p>"
},
"Recurrence":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For more information, see <a href=\"http://en.wikipedia.org/wiki/Cron\">Cron</a> in Wikipedia.</p> <p>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action will start and stop.</p>"
"documentation":"<p>The recurring schedule for this action, in Unix cron syntax format. For more information, see <a href=\"http://en.wikipedia.org/wiki/Cron\">Cron</a> in Wikipedia.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
@ -3315,7 +3315,7 @@
},
"DefaultCooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"AvailabilityZones":{
"shape":"AvailabilityZones",
@ -3327,7 +3327,7 @@
},
"HealthCheckGracePeriod":{
"shape":"HealthCheckGracePeriod",
"documentation":"<p>The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
@ -3335,11 +3335,11 @@
},
"VPCZoneIdentifier":{
"shape":"XmlStringMaxLen2047",
"documentation":"<p>The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.</p> <p>When you specify <code>VPCZoneIdentifier</code> with <code>AvailabilityZones</code>, ensure that the subnets' Availability Zones match the values you specify for <code>AvailabilityZones</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.</p> <p>When you specify <code>VPCZoneIdentifier</code> with <code>AvailabilityZones</code>, ensure that the subnets' Availability Zones match the values you specify for <code>AvailabilityZones</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"TerminationPolicies":{
"shape":"TerminationPolicies",
"documentation":"<p>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.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>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.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"NewInstancesProtectedFromScaleIn":{
"shape":"InstanceProtected",

777
botocore/data/budgets/2016-10-20/service-2.json Executable file
View file

@ -0,0 +1,777 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-10-20",
"endpointPrefix":"budgets",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"AWSBudgets",
"serviceFullName":"AWS Budgets",
"signatureVersion":"v4",
"targetPrefix":"AWSBudgetServiceGateway"
},
"operations":{
"CreateBudget":{
"name":"CreateBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateBudgetRequest"},
"output":{"shape":"CreateBudgetResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InternalErrorException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"}
],
"documentation":"Create a new budget"
},
"CreateNotification":{
"name":"CreateNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateNotificationRequest"},
"output":{"shape":"CreateNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"}
],
"documentation":"Create a new Notification with subscribers for a budget"
},
"CreateSubscriber":{
"name":"CreateSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSubscriberRequest"},
"output":{"shape":"CreateSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"}
],
"documentation":"Create a new Subscriber for a notification"
},
"DeleteBudget":{
"name":"DeleteBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteBudgetRequest"},
"output":{"shape":"DeleteBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Delete a budget and related notifications"
},
"DeleteNotification":{
"name":"DeleteNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteNotificationRequest"},
"output":{"shape":"DeleteNotificationResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InternalErrorException"},
{"shape":"NotFoundException"}
],
"documentation":"Delete a notification and related subscribers"
},
"DeleteSubscriber":{
"name":"DeleteSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteSubscriberRequest"},
"output":{"shape":"DeleteSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Delete a Subscriber for a notification"
},
"DescribeBudget":{
"name":"DescribeBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBudgetRequest"},
"output":{"shape":"DescribeBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Get a single budget"
},
"DescribeBudgets":{
"name":"DescribeBudgets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBudgetsRequest"},
"output":{"shape":"DescribeBudgetsResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"Get all budgets for an account"
},
"DescribeNotificationsForBudget":{
"name":"DescribeNotificationsForBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeNotificationsForBudgetRequest"},
"output":{"shape":"DescribeNotificationsForBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"Get notifications of a budget"
},
"DescribeSubscribersForNotification":{
"name":"DescribeSubscribersForNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSubscribersForNotificationRequest"},
"output":{"shape":"DescribeSubscribersForNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"NotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"Get subscribers of a notification"
},
"UpdateBudget":{
"name":"UpdateBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateBudgetRequest"},
"output":{"shape":"UpdateBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Update the information of a budget already created"
},
"UpdateNotification":{
"name":"UpdateNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateNotificationRequest"},
"output":{"shape":"UpdateNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Update the information about a notification already created"
},
"UpdateSubscriber":{
"name":"UpdateSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSubscriberRequest"},
"output":{"shape":"UpdateSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Update a subscriber"
}
},
"shapes":{
"AccountId":{
"type":"string",
"documentation":"Account Id of the customer. It should be a 12 digit number.",
"max":12,
"min":12
},
"Budget":{
"type":"structure",
"required":[
"BudgetName",
"BudgetLimit",
"CostTypes",
"TimeUnit",
"TimePeriod",
"BudgetType"
],
"members":{
"BudgetName":{"shape":"BudgetName"},
"BudgetLimit":{"shape":"Spend"},
"CostFilters":{"shape":"CostFilters"},
"CostTypes":{"shape":"CostTypes"},
"TimeUnit":{"shape":"TimeUnit"},
"TimePeriod":{"shape":"TimePeriod"},
"CalculatedSpend":{"shape":"CalculatedSpend"},
"BudgetType":{"shape":"BudgetType"}
},
"documentation":"AWS Budget model"
},
"BudgetName":{
"type":"string",
"documentation":"A string represents the budget name. No \":\" character is allowed.",
"max":100,
"pattern":"[^:]+"
},
"BudgetType":{
"type":"string",
"documentation":"The type of a budget. Can be COST or USAGE.",
"enum":[
"USAGE",
"COST"
]
},
"Budgets":{
"type":"list",
"member":{"shape":"Budget"},
"documentation":"A list of budgets"
},
"CalculatedSpend":{
"type":"structure",
"required":["ActualSpend"],
"members":{
"ActualSpend":{"shape":"Spend"},
"ForecastedSpend":{"shape":"Spend"}
},
"documentation":"A structure holds the actual and forecasted spend for a budget."
},
"ComparisonOperator":{
"type":"string",
"documentation":"The comparison operator of a notification. Currently we support less than, equal to and greater than.",
"enum":[
"GREATER_THAN",
"LESS_THAN",
"EQUAL_TO"
]
},
"CostFilters":{
"type":"map",
"key":{"shape":"GenericString"},
"value":{"shape":"DimensionValues"},
"documentation":"A map represents the cost filters applied to the budget."
},
"CostTypes":{
"type":"structure",
"required":[
"IncludeTax",
"IncludeSubscription",
"UseBlended"
],
"members":{
"IncludeTax":{"shape":"GenericBoolean"},
"IncludeSubscription":{"shape":"GenericBoolean"},
"UseBlended":{"shape":"GenericBoolean"}
},
"documentation":"This includes the options for getting the cost of a budget."
},
"CreateBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"Budget"
],
"members":{
"AccountId":{"shape":"AccountId"},
"Budget":{"shape":"Budget"},
"NotificationsWithSubscribers":{"shape":"NotificationWithSubscribersList"}
},
"documentation":"Request of CreateBudget"
},
"CreateBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of CreateBudget"
},
"CreateNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscribers"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscribers":{"shape":"Subscribers"}
},
"documentation":"Request of CreateNotification"
},
"CreateNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of CreateNotification"
},
"CreateSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscriber":{"shape":"Subscriber"}
},
"documentation":"Request of CreateSubscriber"
},
"CreateSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of CreateSubscriber"
},
"CreationLimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.",
"exception":true
},
"DeleteBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"}
},
"documentation":"Request of DeleteBudget"
},
"DeleteBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of DeleteBudget"
},
"DeleteNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"}
},
"documentation":"Request of DeleteNotification"
},
"DeleteNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of DeleteNotification"
},
"DeleteSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscriber":{"shape":"Subscriber"}
},
"documentation":"Request of DeleteSubscriber"
},
"DeleteSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of DeleteSubscriber"
},
"DescribeBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"}
},
"documentation":"Request of DescribeBudget"
},
"DescribeBudgetResponse":{
"type":"structure",
"members":{
"Budget":{"shape":"Budget"}
},
"documentation":"Response of DescribeBudget"
},
"DescribeBudgetsRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{"shape":"AccountId"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
},
"documentation":"Request of DescribeBudgets"
},
"DescribeBudgetsResponse":{
"type":"structure",
"members":{
"Budgets":{"shape":"Budgets"},
"NextToken":{"shape":"GenericString"}
},
"documentation":"Response of DescribeBudgets"
},
"DescribeNotificationsForBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
},
"documentation":"Request of DescribeNotificationsForBudget"
},
"DescribeNotificationsForBudgetResponse":{
"type":"structure",
"members":{
"Notifications":{"shape":"Notifications"},
"NextToken":{"shape":"GenericString"}
},
"documentation":"Response of GetNotificationsForBudget"
},
"DescribeSubscribersForNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
},
"documentation":"Request of DescribeSubscribersForNotification"
},
"DescribeSubscribersForNotificationResponse":{
"type":"structure",
"members":{
"Subscribers":{"shape":"Subscribers"},
"NextToken":{"shape":"GenericString"}
},
"documentation":"Response of DescribeSubscribersForNotification"
},
"DimensionValues":{
"type":"list",
"member":{"shape":"GenericString"}
},
"DuplicateRecordException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"The exception is thrown when customer tries to create a record (e.g. budget) that already exists.",
"exception":true
},
"ExpiredNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown if the paging token is expired - past its TTL",
"exception":true
},
"GenericBoolean":{
"type":"boolean",
"documentation":"A generic boolean value."
},
"GenericString":{
"type":"string",
"documentation":"A generic String."
},
"GenericTimestamp":{
"type":"timestamp",
"documentation":"A generic timestamp. In Java it is transformed to a Date object."
},
"InternalErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown on an unknown internal failure.",
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request",
"exception":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.",
"exception":true
},
"MaxResults":{
"type":"integer",
"documentation":"An integer to represent how many entries should a pagianted response contains. Maxium is set to 100.",
"box":true,
"max":100,
"min":1
},
"NotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.",
"exception":true
},
"Notification":{
"type":"structure",
"required":[
"NotificationType",
"ComparisonOperator",
"Threshold"
],
"members":{
"NotificationType":{"shape":"NotificationType"},
"ComparisonOperator":{"shape":"ComparisonOperator"},
"Threshold":{"shape":"NotificationThreshold"}
},
"documentation":"Notification model. Each budget may contain multiple notifications with different settings."
},
"NotificationThreshold":{
"type":"double",
"documentation":"The threshold of the a notification. It should be a number between 0 and 100.",
"max":100,
"min":0.1
},
"NotificationType":{
"type":"string",
"documentation":"The type of a notification. It should be ACTUAL or FORECASTED.",
"enum":[
"ACTUAL",
"FORECASTED"
]
},
"NotificationWithSubscribers":{
"type":"structure",
"required":[
"Notification",
"Subscribers"
],
"members":{
"Notification":{"shape":"Notification"},
"Subscribers":{"shape":"Subscribers"}
},
"documentation":"A structure to relate notification and a list of subscribers who belong to the notification."
},
"NotificationWithSubscribersList":{
"type":"list",
"member":{"shape":"NotificationWithSubscribers"},
"documentation":"A list of Notifications, each with a list of subscribers.",
"max":5
},
"Notifications":{
"type":"list",
"member":{"shape":"Notification"},
"documentation":"A list of notifications."
},
"NumericValue":{
"type":"string",
"documentation":"A string to represent NumericValue.",
"pattern":"[0-9]+(\\.)?[0-9]*"
},
"Spend":{
"type":"structure",
"required":[
"Amount",
"Unit"
],
"members":{
"Amount":{"shape":"NumericValue"},
"Unit":{"shape":"GenericString"}
},
"documentation":"A structure represent either a cost spend or usage spend. Contains an amount and a unit."
},
"Subscriber":{
"type":"structure",
"required":[
"SubscriptionType",
"Address"
],
"members":{
"SubscriptionType":{"shape":"SubscriptionType"},
"Address":{"shape":"GenericString"}
},
"documentation":"Subscriber model. Each notification may contain multiple subscribers with different addresses."
},
"Subscribers":{
"type":"list",
"member":{"shape":"Subscriber"},
"documentation":"A list of subscribers.",
"max":11,
"min":1
},
"SubscriptionType":{
"type":"string",
"documentation":"The subscription type of the subscriber. It can be SMS or EMAIL.",
"enum":[
"SNS",
"EMAIL"
]
},
"TimePeriod":{
"type":"structure",
"required":[
"Start",
"End"
],
"members":{
"Start":{"shape":"GenericTimestamp"},
"End":{"shape":"GenericTimestamp"}
},
"documentation":"A time period indicated the start date and end date of a budget."
},
"TimeUnit":{
"type":"string",
"documentation":"The time unit of the budget. e.g. weekly, monthly, etc.",
"enum":[
"MONTHLY",
"QUARTERLY",
"ANNUALLY"
]
},
"UpdateBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"NewBudget"
],
"members":{
"AccountId":{"shape":"AccountId"},
"NewBudget":{"shape":"Budget"}
},
"documentation":"Request of UpdateBudget"
},
"UpdateBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of UpdateBudget"
},
"UpdateNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"OldNotification",
"NewNotification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"OldNotification":{"shape":"Notification"},
"NewNotification":{"shape":"Notification"}
},
"documentation":"Request of UpdateNotification"
},
"UpdateNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of UpdateNotification"
},
"UpdateSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"OldSubscriber",
"NewSubscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"OldSubscriber":{"shape":"Subscriber"},
"NewSubscriber":{"shape":"Subscriber"}
},
"documentation":"Request of UpdateSubscriber"
},
"UpdateSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of UpdateSubscriber"
},
"errorMessage":{
"type":"string",
"documentation":"The error message the exception carries."
}
},
"documentation":"All public APIs for AWS Budgets"
}

136
botocore/data/cloudformation/2010-05-15/service-2.json
View file

@ -47,7 +47,7 @@
{"shape":"InsufficientCapabilitiesException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the stack's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change and how it will change them before you update your stack. Change sets allow you to check before you make a change so that you don't delete or replace critical resources.</p> <p>AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the <a>ExecuteChangeSet</a> action.</p> <p>After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the <a>DescribeChangeSet</a> action.</p>"
"documentation":"<p>Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources.</p> <p>AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the <a>ExecuteChangeSet</a> action.</p> <p>After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the <a>DescribeChangeSet</a> action.</p>"
},
"CreateStack":{
"name":"CreateStack",
@ -255,6 +255,19 @@
},
"documentation":"<p>Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or <code>CREATE_PENDING</code> state.</p>"
},
"ListExports":{
"name":"ListExports",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListExportsInput"},
"output":{
"shape":"ListExportsOutput",
"resultWrapper":"ListExportsResult"
},
"documentation":"<p>Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> AWS CloudFormation Export Stack Output Values</a>.</p>"
},
"ListStackResources":{
"name":"ListStackResources",
"http":{
@ -497,6 +510,13 @@
},
"documentation":"<p>The <code>ChangeSetSummary</code> structure describes a change set, its status, and the stack with which it's associated.</p>"
},
"ChangeSetType":{
"type":"string",
"enum":[
"CREATE",
"UPDATE"
]
},
"ChangeSource":{
"type":"string",
"enum":[
@ -526,11 +546,15 @@
"members":{
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>The name or the unique ID of the stack that you want to continue rolling back.</p>"
"documentation":"<p>The name or the unique ID of the stack that you want to continue rolling back.</p> <note> <p>Don't specify the name of a nested stack (a stack that was created by using the <code>AWS::CloudFormation::Stack</code> resource). Instead, use this operation on the parent stack (the stack that contains the <code>AWS::CloudFormation::Stack</code> resource).</p> </note>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
},
"ResourcesToSkip":{
"shape":"ResourcesToSkip",
"documentation":"<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To specify resources in a nested stack, use the following format: <code>NestedStackName.ResourceLogicalID</code>. You can specify a nested stack resource (the logical ID of an <code>AWS::CloudFormation::Stack</code> resource) only if it's in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p>"
}
},
"documentation":"<p>The input for the <a>ContinueUpdateRollback</a> action.</p>"
@ -599,6 +623,10 @@
"Description":{
"shape":"Description",
"documentation":"<p>A description to help you identify this change set.</p>"
},
"ChangeSetType":{
"shape":"ChangeSetType",
"documentation":"<p>The type of change set operation. Valid values are <code>CREATE</code> and <code>UPDATE</code>:</p> <ul> <li> <p> <code>CREATE</code> - Specify for a change set for a stack that does not yet exist. The stack has an expected unique ID, but no template or resources. It can include multiple change sets.</p> </li> <li> <p> <code>UPDATE</code> - Specify for a change set for an existing stack.</p> </li> </ul>"
}
},
"documentation":"<p>The input for the <a>CreateChangeSet</a> action.</p>"
@ -609,6 +637,10 @@
"Id":{
"shape":"ChangeSetId",
"documentation":"<p>The Amazon Resource Name (ARN) of the change set.</p>"
},
"StackId":{
"shape":"StackId",
"documentation":"<p>The unique ID of the stack.</p>"
}
},
"documentation":"<p>The output for the <a>CreateChangeSet</a> action.</p>"
@ -1023,6 +1055,30 @@
"OBSOLETE"
]
},
"Export":{
"type":"structure",
"members":{
"ExportingStackId":{
"shape":"StackId",
"documentation":"<p>The stack that contains the exported output name and value.</p>"
},
"Name":{
"shape":"ExportName",
"documentation":"<p>The name of exported output value. Use this name and the <code>Fn::ImportValue</code> function to import the associated value into other stacks. The name is defined in the <code>Export</code> field in the associated stack's <code>Outputs</code> section.</p>"
},
"Value":{
"shape":"ExportValue",
"documentation":"<p>The value of the exported output, such as a resource physical ID. This value is defined in the <code>Export</code> field in the associated stack's <code>Outputs</code> section.</p>"
}
},
"documentation":"<p>The <code>Export</code> structure describes the exported output values for a stack.</p>"
},
"ExportName":{"type":"string"},
"ExportValue":{"type":"string"},
"Exports":{
"type":"list",
"member":{"shape":"Export"}
},
"GetStackPolicyInput":{
"type":"structure",
"required":["StackName"],
@ -1046,11 +1102,18 @@
},
"GetTemplateInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"ChangeSetName":{
"shape":"ChangeSetNameOrId",
"documentation":"<p>Returns the template for a change set using the Amazon Resource Name (ARN) or name of the change set. If you specify a name, you must also specify the <code>StackName</code>.</p>"
},
"TemplateStage":{
"shape":"TemplateStage",
"documentation":"<p>The stage of the template that is returned. Valid values are <code>Original</code> and <code>Processed</code>:</p> <ul> <li> <p> <code>Original</code> - Use to return the specified pre-transform template.</p> </li> <li> <p> <code>Processed</code> - Use to return the template after all transforms have been processed.</p> </li> </ul>"
}
},
"documentation":"<p>The input for a <a>GetTemplate</a> action.</p>"
@ -1061,6 +1124,10 @@
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>Structure containing the template body. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>AWS CloudFormation returns the same template that was used when the stack was created.</p>"
},
"StagesAvailable":{
"shape":"StageList",
"documentation":"<p>The available template type. For stacks, both the <code>Original</code> and <code>Processed</code> template types are always available. For change sets, the <code>Original</code> template is always available. After the transforms are processed, the <code>Processed</code> template becomes available.</p>"
}
},
"documentation":"<p>The output for <a>GetTemplate</a> action.</p>"
@ -1113,6 +1180,10 @@
"Metadata":{
"shape":"Metadata",
"documentation":"<p>The value that is defined for the <code>Metadata</code> property of the template.</p>"
},
"DeclaredTransforms":{
"shape":"TransformsList",
"documentation":"<p>A list of the transforms that have been declared in the template.</p>"
}
},
"documentation":"<p>The output for the <a>GetTemplateSummary</a> action.</p>"
@ -1185,6 +1256,28 @@
},
"documentation":"<p>The output for the <a>ListChangeSets</a> action.</p>"
},
"ListExportsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string (provided by the <a>ListExports</a> response output) that identifies the next page of exported output values that you asked to retrieve.</p>"
}
}
},
"ListExportsOutput":{
"type":"structure",
"members":{
"Exports":{
"shape":"Exports",
"documentation":"<p>The output for the <a>ListExports</a> action.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.</p>"
}
}
},
"ListStackResourcesInput":{
"type":"structure",
"required":["StackName"],
@ -1493,6 +1586,10 @@
},
"documentation":"<p>The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.</p>"
},
"ResourceToSkip":{
"type":"string",
"pattern":"[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+"
},
"ResourceType":{
"type":"string",
"max":256,
@ -1502,6 +1599,10 @@
"type":"list",
"member":{"shape":"ResourceType"}
},
"ResourcesToSkip":{
"type":"list",
"member":{"shape":"ResourceToSkip"}
},
"RetainResources":{
"type":"list",
"member":{"shape":"LogicalResourceId"}
@ -1578,6 +1679,10 @@
"shape":"StackName",
"documentation":"<p>The name associated with the stack.</p>"
},
"ChangeSetId":{
"shape":"ChangeSetId",
"documentation":"<p>The unique ID of the change set.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A user-defined description associated with the stack.</p>"
@ -1878,7 +1983,8 @@
"UPDATE_ROLLBACK_IN_PROGRESS",
"UPDATE_ROLLBACK_FAILED",
"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS",
"UPDATE_ROLLBACK_COMPLETE"
"UPDATE_ROLLBACK_COMPLETE",
"REVIEW_IN_PROGRESS"
]
},
"StackStatusFilter":{
@ -1937,6 +2043,10 @@
"type":"list",
"member":{"shape":"Stack"}
},
"StageList":{
"type":"list",
"member":{"shape":"TemplateStage"}
},
"Tag":{
"type":"structure",
"members":{
@ -1988,6 +2098,13 @@
"type":"list",
"member":{"shape":"TemplateParameter"}
},
"TemplateStage":{
"type":"string",
"enum":[
"Original",
"Processed"
]
},
"TemplateURL":{
"type":"string",
"max":1024,
@ -1998,6 +2115,11 @@
"min":1
},
"Timestamp":{"type":"timestamp"},
"TransformName":{"type":"string"},
"TransformsList":{
"type":"list",
"member":{"shape":"TransformName"}
},
"UpdateStackInput":{
"type":"structure",
"required":["StackName"],
@ -2106,11 +2228,15 @@
"CapabilitiesReason":{
"shape":"CapabilitiesReason",
"documentation":"<p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>"
},
"DeclaredTransforms":{
"shape":"TransformsList",
"documentation":"<p>A list of the transforms that have been declared in the template.</p>"
}
},
"documentation":"<p>The output for <a>ValidateTemplate</a> action.</p>"
},
"Version":{"type":"string"}
},
"documentation":"<fullname>AWS CloudFormation</fullname> <p>AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure.</p> <p>With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about this product, go to the <a href=\"http://aws.amazon.com/cloudformation/\">CloudFormation Product Page</a>.</p> <p>Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href=\"http://docs.aws.amazon.com/\">http://docs.aws.amazon.com/</a>.</p>"
"documentation":"<fullname>AWS CloudFormation</fullname> <p>AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.</p> <p>With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about AWS CloudFormation, see the <a href=\"http://aws.amazon.com/cloudformation/\">AWS CloudFormation Product Page</a>.</p> <p>Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href=\"http://docs.aws.amazon.com/\">http://docs.aws.amazon.com/</a>.</p>"
}

12
botocore/data/cloudformation/2010-05-15/waiters-2.json
View file

@ -54,6 +54,12 @@
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "ROLLBACK_COMPLETE",
"matcher": "pathAny",
"state": "failure"
},
{
"expected": "ValidationError",
"matcher": "error",
@ -134,6 +140,12 @@
"matcher": "pathAny",
"state": "failure"
},
{
"expected": "UPDATE_ROLLBACK_COMPLETE",
"matcher": "pathAny",
"state": "failure",
"argument": "Stacks[].StackStatus"
},
{
"expected": "ValidationError",
"matcher": "error",

186
botocore/data/directconnect/2012-10-25/service-2.json
View file

@ -275,6 +275,20 @@
],
"documentation":"<p>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.</p>"
},
"DescribeTags":{
"name":"DescribeTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTagsRequest"},
"output":{"shape":"DescribeTagsResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Describes the tags associated with the specified Direct Connect resources.</p>"
},
"DescribeVirtualGateways":{
"name":"DescribeVirtualGateways",
"http":{
@ -301,6 +315,36 @@
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>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.</p> <p>A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.</p> <p>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.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"DuplicateTagKeysException"},
{"shape":"TooManyTagsException"},
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Adds the specified tags to the specified Direct Connect resource. Each Direct Connect resource can have a maximum of 50 tags.</p> <p>Each tag consists of a key and an optional value. If a tag with the same key is already associated with the Direct Connect resource, this action updates its value.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Removes one or more tags from the specified Direct Connect resource.</p>"
}
},
"shapes":{
@ -691,6 +735,27 @@
},
"documentation":"<p>Container for the parameters to the DescribeInterconnects operation.</p>"
},
"DescribeTagsRequest":{
"type":"structure",
"required":["resourceArns"],
"members":{
"resourceArns":{
"shape":"ResourceArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the Direct Connect resources.</p>"
}
},
"documentation":"<p>Container for the parameters to the DescribeTags operation.</p>"
},
"DescribeTagsResponse":{
"type":"structure",
"members":{
"resourceTags":{
"shape":"ResourceTagList",
"documentation":"<p>Information about the tags.</p>"
}
},
"documentation":"<p>The response received when DescribeTags is called.</p>"
},
"DescribeVirtualInterfacesRequest":{
"type":"structure",
"members":{
@ -721,6 +786,13 @@
"documentation":"<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>",
"exception":true
},
"DuplicateTagKeysException":{
"type":"structure",
"members":{
},
"documentation":"<p>A tag key was specified more than once.</p>",
"exception":true
},
"ErrorMessage":{"type":"string"},
"Interconnect":{
"type":"structure",
@ -909,6 +981,29 @@
"type":"string",
"documentation":"<p>The AWS region where the connection is located.</p> <p>Example: us-east-1</p> <p>Default: None</p>"
},
"ResourceArn":{"type":"string"},
"ResourceArnList":{
"type":"list",
"member":{"shape":"ResourceArn"}
},
"ResourceTag":{
"type":"structure",
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Direct Connect resource.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The tags.</p>"
}
},
"documentation":"<p>The tags associated with a Direct Connect resource.</p>"
},
"ResourceTagList":{
"type":"list",
"member":{"shape":"ResourceTag"}
},
"RouteFilterPrefix":{
"type":"structure",
"members":{
@ -925,6 +1020,97 @@
"documentation":"<p>A list of routes to be advertised to the AWS network in this region (public virtual interface).</p>"
},
"RouterConfig":{"type":"string"},
"Tag":{
"type":"structure",
"required":["key"],
"members":{
"key":{
"shape":"TagKey",
"documentation":"<p>The key of the tag.</p>"
},
"value":{
"shape":"TagValue",
"documentation":"<p>The value of the tag.</p>"
}
},
"documentation":"<p>Information about a tag.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Direct Connect resource.</p> <p>Example: arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-fg5678gh</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The list of tags to add.</p>"
}
},
"documentation":"<p>Container for the parameters to the TagResource operation.</p>"
},
"TagResourceResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>The response received when TagResource is called.</p>"
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TooManyTagsException":{
"type":"structure",
"members":{
},
"documentation":"<p>You have reached the limit on the number of tags that can be assigned to a Direct Connect resource.</p>",
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Direct Connect resource.</p>"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The list of tag keys to remove.</p>"
}
},
"documentation":"<p>Container for the parameters to the UntagResource operation.</p>"
},
"UntagResourceResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>The response received when UntagResource is called.</p>"
},
"VLAN":{
"type":"integer",
"documentation":"<p>The VLAN ID.</p> <p>Example: 101</p>"

12
botocore/data/ecr/2015-09-21/paginators-1.json
View file

@ -5,6 +5,18 @@
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "imageIds"
},
"DescribeImages": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "imageDetails"
},
"DescribeRepositories": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "repositories"
}
}
}

84
botocore/data/ecs/2014-11-13/service-2.json
View file

@ -40,7 +40,7 @@
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>.</p> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> <p>You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an <a>UpdateService</a> operation), the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy.</p> <p>If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.</p> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%.</p> <p>When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).</p> </li> <li> <p>Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul>"
"documentation":"<p>Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>.</p> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> <p>You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition or the desired count of a service with an <a>UpdateService</a> operation), the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy.</p> <p>The <code>minimumHealthyPercent</code> represents a lower limit on the number of your service's tasks that must remain in the <code>RUNNING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>minimumHealthyPercent</code> of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.</p> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of your service's tasks that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>maximumPercent</code> value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%.</p> <p>When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).</p> </li> <li> <p>Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul>"
},
"DeleteCluster":{
"name":"DeleteCluster",
@ -91,7 +91,7 @@
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.</p> <p>If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.</p> <p>Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.</p> <note> <p>If you terminate a running container instance with a connected Amazon ECS container agent, the agent automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).</p> </note>"
"documentation":"<p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.</p> <p>If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.</p> <p>Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.</p> <note> <p>If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).</p> </note>"
},
"DeregisterTaskDefinition":{
"name":"DeregisterTaskDefinition",
@ -583,31 +583,31 @@
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>. </p>"
"documentation":"<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>"
},
"image":{
"shape":"String",
"documentation":"<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p> <ul> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>"
"documentation":"<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>"
},
"cpu":{
"shape":"Integer",
"documentation":"<p>The number of <code>cpu</code> units reserved for the container. A container instance has 1,024 <code>cpu</code> units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul>"
"documentation":"<p>The number of <code>cpu</code> units reserved for the container. A container instance has 1,024 <code>cpu</code> units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul>"
},
"memory":{
"shape":"BoxedInteger",
"documentation":"<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>"
"documentation":"<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>"
},
"memoryReservation":{
"shape":"BoxedInteger",
"documentation":"<p>The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the <code>memory</code> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a <code>memoryReservation</code> of 128 MiB, and a <code>memory</code> hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.</p>"
"documentation":"<p>The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the <code>memory</code> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a <code>memoryReservation</code> of 128 MiB, and a <code>memory</code> hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.</p>"
},
"links":{
"shape":"StringList",
"documentation":"<p>The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings, using the <code>name</code> parameter and optionally, an <code>alias</code> for the link. This construct is analogous to <code>name:alias</code> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each <code>name</code> and <code>alias</code>. For more information on linking Docker containers, see <a href=\"https://docs.docker.com/userguide/dockerlinks/\">https://docs.docker.com/userguide/dockerlinks/</a>. This parameter maps to <code>Links</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p> <important> <p>Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.</p> </important>"
"documentation":"<p>The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings, using the <code>name</code> parameter and optionally, an <code>alias</code> for the link. This construct is analogous to <code>name:alias</code> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each <code>name</code> and <code>alias</code>. For more information on linking Docker containers, see <a href=\"https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/\">https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/</a>. This parameter maps to <code>Links</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.</p> </important>"
},
"portMappings":{
"shape":"PortMappingList",
"documentation":"<p>The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to <code>PortBindings</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--publish</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>. If the network mode of a task definition is set to <code>none</code>, then you cannot specify port mappings. If the network mode of a task definition is set to <code>host</code>, then host ports must either be undefined or they must match the container port in the port mapping.</p> <note> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description of a selected task in the Amazon ECS console, or the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>"
"documentation":"<p>The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to <code>PortBindings</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--publish</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. If the network mode of a task definition is set to <code>none</code>, then you cannot specify port mappings. If the network mode of a task definition is set to <code>host</code>, then host ports must either be undefined or they must match the container port in the port mapping.</p> <note> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description of a selected task in the Amazon ECS console, or the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>"
},
"essential":{
"shape":"BoxedBoolean",
@ -615,75 +615,75 @@
},
"entryPoint":{
"shape":"StringList",
"documentation":"<important> <p>Early versions of the Amazon ECS container agent do not properly handle <code>entryPoint</code> parameters. If you have problems using <code>entryPoint</code>, update your container agent or enter your commands and arguments as <code>command</code> array items instead.</p> </important> <p>The entry point that is passed to the container. This parameter maps to <code>Entrypoint</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/reference/builder/#entrypoint\">https://docs.docker.com/reference/builder/#entrypoint</a>.</p>"
"documentation":"<important> <p>Early versions of the Amazon ECS container agent do not properly handle <code>entryPoint</code> parameters. If you have problems using <code>entryPoint</code>, update your container agent or enter your commands and arguments as <code>command</code> array items instead.</p> </important> <p>The entry point that is passed to the container. This parameter maps to <code>Entrypoint</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#entrypoint\">https://docs.docker.com/engine/reference/builder/#entrypoint</a>.</p>"
},
"command":{
"shape":"StringList",
"documentation":"<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/reference/builder/#cmd\">https://docs.docker.com/reference/builder/#cmd</a>.</p>"
"documentation":"<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>"
},
"environment":{
"shape":"EnvironmentVariables",
"documentation":"<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p> <important> <p>We do not recommend using plain text environment variables for sensitive information, such as credential data.</p> </important>"
"documentation":"<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plain text environment variables for sensitive information, such as credential data.</p> </important>"
},
"mountPoints":{
"shape":"MountPointList",
"documentation":"<p>The mount points for data volumes in your container. This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>The mount points for data volumes in your container. This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"volumesFrom":{
"shape":"VolumeFromList",
"documentation":"<p>Data volumes to mount from another container. This parameter maps to <code>VolumesFrom</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--volumes-from</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>Data volumes to mount from another container. This parameter maps to <code>VolumesFrom</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--volumes-from</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"hostname":{
"shape":"String",
"documentation":"<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"user":{
"shape":"String",
"documentation":"<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"workingDirectory":{
"shape":"String",
"documentation":"<p>The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"disableNetworking":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a>.</p>"
"documentation":"<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a>.</p>"
},
"privileged":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"readonlyRootFilesystem":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p>"
"documentation":"<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p>"
},
"dnsServers":{
"shape":"StringList",
"documentation":"<p>A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"dnsSearchDomains":{
"shape":"StringList",
"documentation":"<p>A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"extraHosts":{
"shape":"HostEntryList",
"documentation":"<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--add-host</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p>"
"documentation":"<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--add-host</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"dockerSecurityOptions":{
"shape":"StringList",
"documentation":"<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </note>"
"documentation":"<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </note>"
},
"dockerLabels":{
"shape":"DockerLabelsMap",
"documentation":"<p>A key/value map of labels to add to the container. This parameter maps to <code>Labels</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--label</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
"documentation":"<p>A key/value map of labels to add to the container. This parameter maps to <code>Labels</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--label</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
},
"ulimits":{
"shape":"UlimitList",
"documentation":"<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
"documentation":"<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
},
"logConfiguration":{
"shape":"LogConfiguration",
"documentation":"<p>The log configuration specification for the container. This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/reference/commandline/run/\">docker run</a>. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <note> <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </note>"
"documentation":"<p>The log configuration specification for the container. This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <note> <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </note>"
}
},
"documentation":"<p>Container definitions are used in task definitions to describe the different containers that are launched as part of a task.</p>"
@ -709,11 +709,11 @@
},
"remainingResources":{
"shape":"Resources",
"documentation":"<p>The remaining resources of the container instance that are available for new tasks.</p>"
"documentation":"<p>For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; any port that is not specified here is available for new tasks.</p>"
},
"registeredResources":{
"shape":"Resources",
"documentation":"<p>The registered resources on the container instance that are in use by current tasks.</p>"
"documentation":"<p>For most resource types, this parameter describes the registered resources on the container instance that are in use by current tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.</p>"
},
"status":{
"shape":"String",
@ -926,11 +926,11 @@
"members":{
"maximumPercent":{
"shape":"BoxedInteger",
"documentation":"<p>The upper limit (as a percentage of the service's <code>desiredCount</code>) of the number of running tasks that can be running in a service during a deployment. The maximum number of tasks during a deployment is the <code>desiredCount</code> multiplied by the <code>maximumPercent</code>/100, rounded down to the nearest integer value.</p>"
"documentation":"<p>The upper limit (as a percentage of the service's <code>desiredCount</code>) of the number of tasks that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state in a service during a deployment. The maximum number of tasks during a deployment is the <code>desiredCount</code> multiplied by the <code>maximumPercent</code>/100, rounded down to the nearest integer value.</p>"
},
"minimumHealthyPercent":{
"shape":"BoxedInteger",
"documentation":"<p>The lower limit (as a percentage of the service's <code>desiredCount</code>) of the number of running tasks that must remain running and healthy in a service during a deployment. The minimum healthy tasks during a deployment is the <code>desiredCount</code> multiplied by the <code>minimumHealthyPercent</code>/100, rounded up to the nearest integer value.</p>"
"documentation":"<p>The lower limit (as a percentage of the service's <code>desiredCount</code>) of the number of running tasks that must remain in the <code>RUNNING</code> state in a service during a deployment. The minimum healthy tasks during a deployment is the <code>desiredCount</code> multiplied by the <code>minimumHealthyPercent</code>/100, rounded up to the nearest integer value.</p>"
}
},
"documentation":"<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>"
@ -953,7 +953,7 @@
},
"force":{
"shape":"BoxedBoolean",
"documentation":"<p>Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> option, these tasks remain running and they continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.</p>"
"documentation":"<p>Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible. </p> <p>Any containers in orphaned service tasks that are registered with a Classic load balancer or an Application load balancer target group are deregistered, and they will begin connection draining according to the settings on the load balancer or target group.</p>"
}
}
},
@ -1041,7 +1041,7 @@
},
"services":{
"shape":"StringList",
"documentation":"<p>A list of services to describe.</p>"
"documentation":"<p>A list of services to describe. You may specify up to 10 services to describe in a single operation.</p>"
}
}
},
@ -1251,7 +1251,7 @@
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed..</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"nextToken":{
"shape":"String",
@ -1281,7 +1281,7 @@
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed..</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"nextToken":{
"shape":"String",
@ -1383,7 +1383,7 @@
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed..</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"containerInstance":{
"shape":"String",
@ -1566,7 +1566,7 @@
},
"hostPort":{
"shape":"BoxedInteger",
"documentation":"<p>The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the <code>hostPort</code> (or set it to <code>0</code>) while specifying a <code>containerPort</code> and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.</p> <p>The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from <code>/proc/sys/net/ipv4/ip_local_port_range</code>; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.</p> <p>The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the <code>remainingResources</code> of <a>DescribeContainerInstances</a> output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).</p>"
"documentation":"<p>The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the <code>hostPort</code> (or set it to <code>0</code>) while specifying a <code>containerPort</code> and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.</p> <p>The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from <code>/proc/sys/net/ipv4/ip_local_port_range</code>; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.</p> <p>The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the <code>remainingResources</code> of <a>DescribeContainerInstances</a> output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).</p>"
},
"protocol":{
"shape":"TransportProtocol",
@ -1584,7 +1584,7 @@
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed..</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"instanceIdentityDocument":{
"shape":"String",
@ -1631,7 +1631,7 @@
},
"taskRoleArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for Tasks</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
},
"networkMode":{
"shape":"NetworkMode",
@ -1700,7 +1700,7 @@
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed..</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"taskDefinition":{
"shape":"String",
@ -1860,7 +1860,7 @@
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"taskDefinition":{
"shape":"String",
@ -1899,7 +1899,7 @@
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed..</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"task":{
"shape":"String",

40
botocore/data/elbv2/2015-12-01/service-2.json
View file

@ -27,7 +27,7 @@
{"shape":"LoadBalancerNotFoundException"},
{"shape":"TargetGroupNotFoundException"}
],
"documentation":"<p>Adds the specified tags to the specified resource. You can tag your Application load balancers and your target groups.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, <code>AddTags</code> updates its value.</p> <p>To list the current tags for your resources, use <a>DescribeTags</a>. To remove tags from your resources, use <a>RemoveTags</a>.</p>"
"documentation":"<p>Adds the specified tags to the specified resource. You can tag your Application Load Balancers and your target groups.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, <code>AddTags</code> updates its value.</p> <p>To list the current tags for your resources, use <a>DescribeTags</a>. To remove tags from your resources, use <a>RemoveTags</a>.</p>"
},
"CreateListener":{
"name":"CreateListener",
@ -54,7 +54,7 @@
{"shape":"UnsupportedProtocolException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
],
"documentation":"<p>Creates a listener for the specified Application load balancer.</p> <p>To update a listener, use <a>ModifyListener</a>. When you are finished with a listener, you can delete it using <a>DeleteListener</a>. If you are finished with both the listener and the load balancer, you can delete them both using <a>DeleteLoadBalancer</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>"
"documentation":"<p>Creates a listener for the specified Application Load Balancer.</p> <p>You can create up to 10 listeners per load balancer.</p> <p>To update a listener, use <a>ModifyListener</a>. When you are finished with a listener, you can delete it using <a>DeleteListener</a>. If you are finished with both the listener and the load balancer, you can delete them both using <a>DeleteLoadBalancer</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"CreateLoadBalancer":{
"name":"CreateLoadBalancer",
@ -78,7 +78,7 @@
{"shape":"TooManyTagsException"},
{"shape":"DuplicateTagKeysException"}
],
"documentation":"<p>Creates an Application load balancer.</p> <p>To create listeners for your load balancer, use <a>CreateListener</a>. You can add security groups, subnets, and tags when you create your load balancer, or you can add them later using <a>SetSecurityGroups</a>, <a>SetSubnets</a>, and <a>AddTags</a>.</p> <p>To describe your current load balancers, see <a>DescribeLoadBalancers</a>. When you are finished with a load balancer, you can delete it using <a>DeleteLoadBalancer</a>.</p> <p>You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancer</a> in the <i>Application Load Balancers Guide</i>.</p>"
"documentation":"<p>Creates an Application Load Balancer.</p> <p>To create listeners for your load balancer, use <a>CreateListener</a>. You can add security groups, subnets, and tags when you create your load balancer, or you can add them later using <a>SetSecurityGroups</a>, <a>SetSubnets</a>, and <a>AddTags</a>.</p> <p>To describe your current load balancers, see <a>DescribeLoadBalancers</a>. When you are finished with a load balancer, you can delete it using <a>DeleteLoadBalancer</a>.</p> <p>You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancer</a> in the <i>Application Load Balancers Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html\">Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"CreateRule":{
"name":"CreateRule",
@ -101,7 +101,7 @@
{"shape":"InvalidConfigurationRequestException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
],
"documentation":"<p>Creates a rule for the specified listener.</p> <p>A rule consists conditions and actions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, the specified actions are taken. If no rule's conditions are met, the default actions for the listener are taken.</p> <p>To view your current rules, use <a>DescribeRules</a>. To update a rule, use <a>ModifyRule</a>. To set the priorities of your rules, use <a>SetRulePriorities</a>. To delete a rule, use <a>DeleteRule</a>.</p>"
"documentation":"<p>Creates a rule for the specified listener.</p> <p>Each rule can have one action and one condition. Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the default action for the default rule is taken. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules\">Listener Rules</a> in the <i>Application Load Balancers Guide</i>.</p> <p>To view your current rules, use <a>DescribeRules</a>. To update a rule, use <a>ModifyRule</a>. To set the priorities of your rules, use <a>SetRulePriorities</a>. To delete a rule, use <a>DeleteRule</a>.</p>"
},
"CreateTargetGroup":{
"name":"CreateTargetGroup",
@ -151,7 +151,7 @@
{"shape":"LoadBalancerNotFoundException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Deletes the specified load balancer and its attached listeners.</p> <p>You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.</p> <p>Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.</p>"
"documentation":"<p>Deletes the specified Application Load Balancer and its attached listeners.</p> <p>You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.</p> <p>Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.</p>"
},
"DeleteRule":{
"name":"DeleteRule",
@ -218,7 +218,7 @@
{"shape":"ListenerNotFoundException"},
{"shape":"LoadBalancerNotFoundException"}
],
"documentation":"<p>Describes the specified listeners or the listeners for the specified load balancer. You must specify either a load balancer or one or more listeners.</p>"
"documentation":"<p>Describes the specified listeners or the listeners for the specified Application Load Balancer. You must specify either a load balancer or one or more listeners.</p>"
},
"DescribeLoadBalancerAttributes":{
"name":"DescribeLoadBalancerAttributes",
@ -234,7 +234,7 @@
"errors":[
{"shape":"LoadBalancerNotFoundException"}
],
"documentation":"<p>Describes the attributes for the specified load balancer.</p>"
"documentation":"<p>Describes the attributes for the specified Application Load Balancer.</p>"
},
"DescribeLoadBalancers":{
"name":"DescribeLoadBalancers",
@ -250,7 +250,7 @@
"errors":[
{"shape":"LoadBalancerNotFoundException"}
],
"documentation":"<p>Describes the specified Application load balancers or all of your Application load balancers.</p> <p>To describe the listeners for a load balancer, use <a>DescribeListeners</a>. To describe the attributes for a load balancer, use <a>DescribeLoadBalancerAttributes</a>.</p>"
"documentation":"<p>Describes the specified Application Load Balancers or all of your Application Load Balancers.</p> <p>To describe the listeners for a load balancer, use <a>DescribeListeners</a>. To describe the attributes for a load balancer, use <a>DescribeLoadBalancerAttributes</a>.</p>"
},
"DescribeRules":{
"name":"DescribeRules",
@ -397,7 +397,7 @@
{"shape":"LoadBalancerNotFoundException"},
{"shape":"InvalidConfigurationRequestException"}
],
"documentation":"<p>Modifies the specified attributes of the specified load balancer.</p> <p>If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.</p>"
"documentation":"<p>Modifies the specified attributes of the specified Application Load Balancer.</p> <p>If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.</p>"
},
"ModifyRule":{
"name":"ModifyRule",
@ -467,7 +467,7 @@
{"shape":"InvalidTargetException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
],
"documentation":"<p>Registers the specified targets with the specified target group.</p> <p>The target must be in the virtual private cloud (VPC) that you specified for the target group.</p> <p>To remove a target from a target group, use <a>DeregisterTargets</a>.</p>"
"documentation":"<p>Registers the specified targets with the specified target group.</p> <p>By default, the load balancer routes requests to registered targets using the protocol and port number for the target group. Alternatively, you can override the port for a target when you register it.</p> <p>The target must be in the virtual private cloud (VPC) that you specified for the target group. If the target is an EC2 instance, it can't be in the <code>stopped</code> or <code>running</code> state when you register it.</p> <p>To remove a target from a target group, use <a>DeregisterTargets</a>.</p>"
},
"RemoveTags":{
"name":"RemoveTags",
@ -697,7 +697,7 @@
},
"DefaultActions":{
"shape":"Actions",
"documentation":"<p>The default actions for the listener.</p>"
"documentation":"<p>The default action for the listener.</p>"
}
},
"documentation":"<p>Contains the parameters for CreateListener.</p>"
@ -767,7 +767,7 @@
},
"Conditions":{
"shape":"RuleConditionList",
"documentation":"<p>The conditions.</p>"
"documentation":"<p>A condition. Each condition has the field <code>path-pattern</code> and specifies one path pattern. A path pattern is case sensitive, can be up to 255 characters in length, and can contain any of the following characters:</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
},
"Priority":{
"shape":"RulePriority",
@ -775,7 +775,7 @@
},
"Actions":{
"shape":"Actions",
"documentation":"<p>The actions for the rule.</p>"
"documentation":"<p>An action. Each action has the type <code>forward</code> and specifies a target group.</p>"
}
},
"documentation":"<p>Contains the parameters for CreateRule.</p>"
@ -943,7 +943,7 @@
},
"Targets":{
"shape":"TargetDescriptions",
"documentation":"<p>The targets.</p>"
"documentation":"<p>The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.</p>"
}
},
"documentation":"<p>Contains the parameters for DeregisterTargets.</p>"
@ -1479,7 +1479,7 @@
"members":{
"Key":{
"shape":"LoadBalancerAttributeKey",
"documentation":"<p>The name of the attribute.</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs stored in Amazon S3 are enabled.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket. If you don't specify a prefix, the access logs are stored in the root of the bucket.</p> </li> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled.</p> </li> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-3600. The default is 60 seconds.</p> </li> </ul>"
"documentation":"<p>The name of the attribute.</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs stored in Amazon S3 are enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket. If you don't specify a prefix, the access logs are stored in the root of the bucket.</p> </li> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-3600. The default is 60 seconds.</p> </li> </ul>"
},
"Value":{
"shape":"LoadBalancerAttributeValue",
@ -1806,7 +1806,7 @@
},
"Targets":{
"shape":"TargetDescriptions",
"documentation":"<p>The targets.</p>"
"documentation":"<p>The targets. The default port for a target is the port for the target group. You can specify a port override. If a target is already registered, you can register it again using a different port.</p>"
}
},
"documentation":"<p>Contains the parameters for RegisterTargets.</p>"
@ -1894,11 +1894,11 @@
"members":{
"Field":{
"shape":"ConditionFieldName",
"documentation":"<p>The name of the field. The possible value is <code>path-pattern</code>.</p>"
"documentation":"<p>The only possible value is <code>path-pattern</code>.</p>"
},
"Values":{
"shape":"ListOfString",
"documentation":"<p>The values for the field.</p> <p>A path pattern is case sensitive, can be up to 255 characters in length, and can contain any of the following characters:</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp;amp; (using &amp;amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
"documentation":"<p>The path pattern. You can specify a single path pattern.</p> <p>A path pattern is case sensitive, can be up to 255 characters in length, and can contain any of the following characters:</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
}
},
"documentation":"<p>Information about a condition for a rule.</p>"
@ -2249,7 +2249,7 @@
"members":{
"Key":{
"shape":"TargetGroupAttributeKey",
"documentation":"<p>The name of the attribute.</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds.</p> </li> <li> <p> <code>stickiness.enabled</code> - Indicates whether sticky sessions are enabled.</p> </li> <li> <p> <code>stickiness.type</code> - The type of sticky sessions. The possible value is <code>lb_cookie</code>.</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul>"
"documentation":"<p>The name of the attribute.</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds.</p> </li> <li> <p> <code>stickiness.enabled</code> - Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - The type of sticky sessions. The possible value is <code>lb_cookie</code>.</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul>"
},
"Value":{
"shape":"TargetGroupAttributeValue",
@ -2466,5 +2466,5 @@
"VpcId":{"type":"string"},
"ZoneName":{"type":"string"}
},
"documentation":"<fullname>Elastic Load Balancing</fullname> <p>A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.</p> <p>Elastic Load Balancing supports two types of load balancers: Classic load balancers and Application load balancers (new). A Classic load balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application load balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>This reference covers the 2015-12-01 API, which supports Application load balancers. The 2012-06-01 API supports Classic load balancers.</p> <p>To get started with an Application load balancer, complete the following tasks:</p> <ol> <li> <p>Create a load balancer using <a>CreateLoadBalancer</a>.</p> </li> <li> <p>Create a target group using <a>CreateTargetGroup</a>.</p> </li> <li> <p>Register targets for the target group using <a>RegisterTargets</a>.</p> </li> <li> <p>Create one or more listeners for your load balancer using <a>CreateListener</a>.</p> </li> <li> <p>(Optional) Create one or more rules for content routing based on URL using <a>CreateRule</a>.</p> </li> </ol> <p>To delete an Application load balancer and its related resources, complete the following tasks:</p> <ol> <li> <p>Delete the load balancer using <a>DeleteLoadBalancer</a>.</p> </li> <li> <p>Delete the target group using <a>DeleteTargetGroup</a>.</p> </li> </ol> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>"
"documentation":"<fullname>Elastic Load Balancing</fullname> <p>A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.</p> <p>Elastic Load Balancing supports two types of load balancers: Classic Load Balancers and Application Load Balancers. A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>This reference covers the 2015-12-01 API, which supports Application Load Balancers. The 2012-06-01 API supports Classic Load Balancers.</p> <p>To get started, complete the following tasks:</p> <ol> <li> <p>Create an Application Load Balancer using <a>CreateLoadBalancer</a>.</p> </li> <li> <p>Create a target group using <a>CreateTargetGroup</a>.</p> </li> <li> <p>Register targets for the target group using <a>RegisterTargets</a>.</p> </li> <li> <p>Create one or more listeners for your load balancer using <a>CreateListener</a>.</p> </li> <li> <p>(Optional) Create one or more rules for content routing based on URL using <a>CreateRule</a>.</p> </li> </ol> <p>To delete an Application Load Balancer and its related resources, complete the following tasks:</p> <ol> <li> <p>Delete the load balancer using <a>DeleteLoadBalancer</a>.</p> </li> <li> <p>Delete the target group using <a>DeleteTargetGroup</a>.</p> </li> </ol> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>"
}

12
botocore/data/endpoints.json
View file

@ -150,6 +150,18 @@
"eu-central-1": {}
}
},
"budgets": {
"partitionEndpoint": "aws-global",
"isRegionalized": false,
"endpoints": {
"aws-global": {
"hostname": "budgets.amazonaws.com",
"credentialScope": {
"region": "us-east-1"
}
}
}
},
"cloudfront": {
"partitionEndpoint": "aws-global",
"isRegionalized": false,

570
botocore/data/ses/2010-12-01/service-2.json
View file

@ -29,6 +29,44 @@
],
"documentation":"<p>Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.</p> <p>For information about setting up rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"CreateConfigurationSet":{
"name":"CreateConfigurationSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateConfigurationSetRequest"},
"output":{
"shape":"CreateConfigurationSetResponse",
"resultWrapper":"CreateConfigurationSetResult"
},
"errors":[
{"shape":"ConfigurationSetAlreadyExistsException"},
{"shape":"InvalidConfigurationSetException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"CreateConfigurationSetEventDestination":{
"name":"CreateConfigurationSetEventDestination",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateConfigurationSetEventDestinationRequest"},
"output":{
"shape":"CreateConfigurationSetEventDestinationResponse",
"resultWrapper":"CreateConfigurationSetEventDestinationResult"
},
"errors":[
{"shape":"ConfigurationSetDoesNotExistException"},
{"shape":"EventDestinationAlreadyExistsException"},
{"shape":"InvalidCloudWatchDestinationException"},
{"shape":"InvalidFirehoseDestinationException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a configuration set event destination.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.</p> </note> <p>An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"CreateReceiptFilter":{
"name":"CreateReceiptFilter",
"http":{
@ -85,6 +123,39 @@
],
"documentation":"<p>Creates an empty receipt rule set.</p> <p>For information about setting up receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"DeleteConfigurationSet":{
"name":"DeleteConfigurationSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConfigurationSetRequest"},
"output":{
"shape":"DeleteConfigurationSetResponse",
"resultWrapper":"DeleteConfigurationSetResult"
},
"errors":[
{"shape":"ConfigurationSetDoesNotExistException"}
],
"documentation":"<p>Deletes a configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"DeleteConfigurationSetEventDestination":{
"name":"DeleteConfigurationSetEventDestination",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConfigurationSetEventDestinationRequest"},
"output":{
"shape":"DeleteConfigurationSetEventDestinationResponse",
"resultWrapper":"DeleteConfigurationSetEventDestinationResult"
},
"errors":[
{"shape":"ConfigurationSetDoesNotExistException"},
{"shape":"EventDestinationDoesNotExistException"}
],
"documentation":"<p>Deletes a configuration set event destination.</p> <p>Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"DeleteIdentity":{
"name":"DeleteIdentity",
"http":{
@ -178,6 +249,22 @@
},
"documentation":"<p>Returns the metadata and receipt rules for the receipt rule set that is currently active.</p> <p>For information about setting up receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"DescribeConfigurationSet":{
"name":"DescribeConfigurationSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConfigurationSetRequest"},
"output":{
"shape":"DescribeConfigurationSetResponse",
"resultWrapper":"DescribeConfigurationSetResult"
},
"errors":[
{"shape":"ConfigurationSetDoesNotExistException"}
],
"documentation":"<p>Returns the details of the specified configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"DescribeReceiptRule":{
"name":"DescribeReceiptRule",
"http":{
@ -300,6 +387,19 @@
},
"documentation":"<p>Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity.</p> <p>Each data point in the list contains statistics for a 15-minute interval.</p> <p>This action is throttled at one request per second.</p>"
},
"ListConfigurationSets":{
"name":"ListConfigurationSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListConfigurationSetsRequest"},
"output":{
"shape":"ListConfigurationSetsResponse",
"resultWrapper":"ListConfigurationSetsResult"
},
"documentation":"<p>Lists the configuration sets associated with your AWS account.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second and can return up to 50 configuration sets at a time.</p>"
},
"ListIdentities":{
"name":"ListIdentities",
"http":{
@ -426,7 +526,8 @@
},
"errors":[
{"shape":"MessageRejected"},
{"shape":"MailFromDomainNotVerifiedException"}
{"shape":"MailFromDomainNotVerifiedException"},
{"shape":"ConfigurationSetDoesNotExistException"}
],
"documentation":"<p>Composes an email message based on input data, and then immediately queues the message for sending.</p> <p>There are several important points to know about <code>SendEmail</code>:</p> <ul> <li> <p>You can only send email from verified email addresses and domains; otherwise, you will get an \"Email address not verified\" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> </li> <li> <p>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</p> </li> <li> <p>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</p> </li> <li> <p>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html\">Amazon SES Developer Guide</a>.</p> </li> </ul>"
},
@ -443,7 +544,8 @@
},
"errors":[
{"shape":"MessageRejected"},
{"shape":"MailFromDomainNotVerifiedException"}
{"shape":"MailFromDomainNotVerifiedException"},
{"shape":"ConfigurationSetDoesNotExistException"}
],
"documentation":"<p>Sends an email message, with header and content specified by the client. The <code>SendRawEmail</code> action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent. </p> <p>There are several important points to know about <code>SendRawEmail</code>:</p> <ul> <li> <p>You can only send email from verified email addresses and domains; otherwise, you will get an \"Email address not verified\" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> </li> <li> <p>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</p> </li> <li> <p>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</p> </li> <li> <p>The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.</p> </li> <li> <p>Amazon SES overrides any Message-ID and Date headers you provide.</p> </li> <li> <p>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html\">Amazon SES Developer Guide</a>.</p> </li> <li> <p>If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> enables you to specify the cross-account identity for the email's \"Source,\" \"From,\" and \"Return-Path\" parameters in one of two ways: you can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>, and/or <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw email:</p> <ul> <li> <p> <code>X-SES-SOURCE-ARN</code> </p> </li> <li> <p> <code>X-SES-FROM-ARN</code> </p> </li> <li> <p> <code>X-SES-RETURN-PATH-ARN</code> </p> </li> </ul> <important> <p>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</p> </important> <p>For the most common sending authorization use case, we recommend that you specify the <code>SourceIdentityArn</code> and do not specify either the <code>FromIdentityArn</code> or <code>ReturnPathIdentityArn</code>. (The same note applies to the corresponding X-headers.) If you only specify the <code>SourceIdentityArn</code>, Amazon SES will simply set the \"From\" address and the \"Return Path\" address to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> </li> </ul>"
},
@ -545,6 +647,25 @@
],
"documentation":"<p>Sets the position of the specified receipt rule in the receipt rule set.</p> <p>For information about managing receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"UpdateConfigurationSetEventDestination":{
"name":"UpdateConfigurationSetEventDestination",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateConfigurationSetEventDestinationRequest"},
"output":{
"shape":"UpdateConfigurationSetEventDestinationResponse",
"resultWrapper":"UpdateConfigurationSetEventDestinationResult"
},
"errors":[
{"shape":"ConfigurationSetDoesNotExistException"},
{"shape":"EventDestinationDoesNotExistException"},
{"shape":"InvalidCloudWatchDestinationException"},
{"shape":"InvalidFirehoseDestinationException"}
],
"documentation":"<p>Updates the event destination of a configuration set.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.</p> </note> <p>Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>"
},
"UpdateReceiptRule":{
"name":"UpdateReceiptRule",
"http":{
@ -644,7 +765,7 @@
"members":{
"Name":{"shape":"RuleOrRuleSetName"}
},
"documentation":"<p>Indicates that a resource could not be created due to a naming conflict.</p>",
"documentation":"<p>Indicates that a resource could not be created because of a naming conflict.</p>",
"error":{
"code":"AlreadyExists",
"httpStatusCode":400,
@ -786,6 +907,94 @@
},
"documentation":"<p>An empty element returned on a successful request.</p>"
},
"CloudWatchDestination":{
"type":"structure",
"required":["DimensionConfigurations"],
"members":{
"DimensionConfigurations":{
"shape":"CloudWatchDimensionConfigurations",
"documentation":"<p>A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.</p>"
}
},
"documentation":"<p>Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.</p> <p>Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"CloudWatchDimensionConfiguration":{
"type":"structure",
"required":[
"DimensionName",
"DimensionValueSource",
"DefaultDimensionValue"
],
"members":{
"DimensionName":{
"shape":"DimensionName",
"documentation":"<p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
},
"DimensionValueSource":{
"shape":"DimensionValueSource",
"documentation":"<p>The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an <code>X-SES-MESSAGE-TAGS</code> header or a parameter to the <code>SendEmail</code>/<code>SendRawEmail</code> API, choose <code>messageTag</code>. If you want Amazon SES to use your own email headers, choose <code>emailHeader</code>.</p>"
},
"DefaultDimensionValue":{
"shape":"DefaultDimensionValue",
"documentation":"<p>The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
}
},
"documentation":"<p>Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.</p> <p>For information about publishing email sending events to Amazon CloudWatch, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"CloudWatchDimensionConfigurations":{
"type":"list",
"member":{"shape":"CloudWatchDimensionConfiguration"}
},
"ConfigurationSet":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>"
}
},
"documentation":"<p>The name of the configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"ConfigurationSetAlreadyExistsException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"}
},
"documentation":"<p>Indicates that the configuration set could not be created because of a naming conflict.</p>",
"error":{
"code":"ConfigurationSetAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ConfigurationSetAttribute":{
"type":"string",
"enum":["eventDestinations"]
},
"ConfigurationSetAttributeList":{
"type":"list",
"member":{"shape":"ConfigurationSetAttribute"}
},
"ConfigurationSetDoesNotExistException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"}
},
"documentation":"<p>Indicates that the configuration set does not exist.</p>",
"error":{
"code":"ConfigurationSetDoesNotExist",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ConfigurationSetName":{"type":"string"},
"ConfigurationSets":{
"type":"list",
"member":{"shape":"ConfigurationSet"}
},
"Content":{
"type":"structure",
"required":["Data"],
@ -802,6 +1011,47 @@
"documentation":"<p>Represents textual data, plus an optional character set specification.</p> <p>By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.</p>"
},
"Counter":{"type":"long"},
"CreateConfigurationSetEventDestinationRequest":{
"type":"structure",
"required":[
"ConfigurationSetName",
"EventDestination"
],
"members":{
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set to which to apply the event destination.</p>"
},
"EventDestination":{
"shape":"EventDestination",
"documentation":"<p>An object that describes the AWS service to which Amazon SES will publish the email sending events associated with the specified configuration set.</p>"
}
},
"documentation":"<p>Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an AWS service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"CreateConfigurationSetEventDestinationResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>An empty element returned on a successful request.</p>"
},
"CreateConfigurationSetRequest":{
"type":"structure",
"required":["ConfigurationSet"],
"members":{
"ConfigurationSet":{
"shape":"ConfigurationSet",
"documentation":"<p>A data structure that contains the name of the configuration set.</p>"
}
},
"documentation":"<p>Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"CreateConfigurationSetResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>An empty element returned on a successful request.</p>"
},
"CreateReceiptFilterRequest":{
"type":"structure",
"required":["Filter"],
@ -873,6 +1123,48 @@
"TemporaryFailure"
]
},
"DefaultDimensionValue":{"type":"string"},
"DeleteConfigurationSetEventDestinationRequest":{
"type":"structure",
"required":[
"ConfigurationSetName",
"EventDestinationName"
],
"members":{
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set from which to delete the event destination.</p>"
},
"EventDestinationName":{
"shape":"EventDestinationName",
"documentation":"<p>The name of the event destination to delete.</p>"
}
},
"documentation":"<p>Represents a request to delete a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"DeleteConfigurationSetEventDestinationResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>An empty element returned on a successful request.</p>"
},
"DeleteConfigurationSetRequest":{
"type":"structure",
"required":["ConfigurationSetName"],
"members":{
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set to delete.</p>"
}
},
"documentation":"<p>Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"DeleteConfigurationSetResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>An empty element returned on a successful request.</p>"
},
"DeleteIdentityPolicyRequest":{
"type":"structure",
"required":[
@ -1003,6 +1295,35 @@
},
"documentation":"<p>Represents the metadata and receipt rules for the receipt rule set that is currently active.</p>"
},
"DescribeConfigurationSetRequest":{
"type":"structure",
"required":["ConfigurationSetName"],
"members":{
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set to describe.</p>"
},
"ConfigurationSetAttributeNames":{
"shape":"ConfigurationSetAttributeList",
"documentation":"<p>A list of configuration set attributes to return.</p>"
}
},
"documentation":"<p>Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"DescribeConfigurationSetResponse":{
"type":"structure",
"members":{
"ConfigurationSet":{
"shape":"ConfigurationSet",
"documentation":"<p>The configuration set object associated with the specified configuration set.</p>"
},
"EventDestinations":{
"shape":"EventDestinations",
"documentation":"<p>A list of event destinations associated with the configuration set. </p>"
}
},
"documentation":"<p>Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"DescribeReceiptRuleRequest":{
"type":"structure",
"required":[
@ -1075,6 +1396,14 @@
"documentation":"<p>Represents the destination of the message, consisting of To:, CC:, and BCC: fields.</p> <p> By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"http://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>"
},
"DiagnosticCode":{"type":"string"},
"DimensionName":{"type":"string"},
"DimensionValueSource":{
"type":"string",
"enum":[
"messageTag",
"emailHeader"
]
},
"DkimAttributes":{
"type":"map",
"key":{"shape":"Identity"},
@ -1093,6 +1422,83 @@
},
"DsnStatus":{"type":"string"},
"Enabled":{"type":"boolean"},
"EventDestination":{
"type":"structure",
"required":[
"Name",
"MatchingEventTypes"
],
"members":{
"Name":{
"shape":"EventDestinationName",
"documentation":"<p>The name of the event destination. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>"
},
"Enabled":{
"shape":"Enabled",
"documentation":"<p>Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to <code>true</code> to enable publishing to this destination; set to <code>false</code> to prevent publishing to this destination. The default value is <code>false</code>.</p>"
},
"MatchingEventTypes":{
"shape":"EventTypes",
"documentation":"<p>The type of email sending events to publish to the event destination.</p>"
},
"KinesisFirehoseDestination":{
"shape":"KinesisFirehoseDestination",
"documentation":"<p>An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.</p>"
},
"CloudWatchDestination":{
"shape":"CloudWatchDestination",
"documentation":"<p>An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.</p>"
}
},
"documentation":"<p>Contains information about the event destination to which the specified email sending events are published.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.</p> </note> <p>Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"EventDestinationAlreadyExistsException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"},
"EventDestinationName":{"shape":"EventDestinationName"}
},
"documentation":"<p>Indicates that the event destination could not be created because of a naming conflict.</p>",
"error":{
"code":"EventDestinationAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"EventDestinationDoesNotExistException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"},
"EventDestinationName":{"shape":"EventDestinationName"}
},
"documentation":"<p>Indicates that the event destination does not exist.</p>",
"error":{
"code":"EventDestinationDoesNotExist",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"EventDestinationName":{"type":"string"},
"EventDestinations":{
"type":"list",
"member":{"shape":"EventDestination"}
},
"EventType":{
"type":"string",
"enum":[
"send",
"reject",
"bounce",
"complaint",
"delivery"
]
},
"EventTypes":{
"type":"list",
"member":{"shape":"EventType"}
},
"Explanation":{"type":"string"},
"ExtensionField":{
"type":"structure",
@ -1275,7 +1681,7 @@
"members":{
"DkimEnabled":{
"shape":"Enabled",
"documentation":"<p>True if DKIM signing is enabled for email sent from the identity; false otherwise.</p>"
"documentation":"<p>True if DKIM signing is enabled for email sent from the identity; false otherwise. The default value is true.</p>"
},
"DkimVerificationStatus":{
"shape":"VerificationStatus",
@ -1377,6 +1783,46 @@
},
"documentation":"<p>Represents the verification attributes of a single identity.</p>"
},
"InvalidCloudWatchDestinationException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"},
"EventDestinationName":{"shape":"EventDestinationName"}
},
"documentation":"<p>Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.</p>",
"error":{
"code":"InvalidCloudWatchDestination",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidConfigurationSetException":{
"type":"structure",
"members":{
},
"documentation":"<p>Indicates that the configuration set is invalid. See the error message for details.</p>",
"error":{
"code":"InvalidConfigurationSet",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidFirehoseDestinationException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"},
"EventDestinationName":{"shape":"EventDestinationName"}
},
"documentation":"<p>Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.</p>",
"error":{
"code":"InvalidFirehoseDestination",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidLambdaFunctionException":{
"type":"structure",
"members":{
@ -1435,6 +1881,24 @@
"RequestResponse"
]
},
"KinesisFirehoseDestination":{
"type":"structure",
"required":[
"IAMRoleARN",
"DeliveryStreamARN"
],
"members":{
"IAMRoleARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.</p>"
},
"DeliveryStreamARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the Amazon Kinesis Firehose stream to which to publish email sending events.</p>"
}
},
"documentation":"<p>Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.</p> <p>Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"LambdaAction":{
"type":"structure",
"required":["FunctionArn"],
@ -1459,7 +1923,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html\">Amazon SES Developer Guide</a>.</p>",
"documentation":"<p>Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html\">Amazon SES Developer Guide</a>.</p>",
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
@ -1467,6 +1931,34 @@
},
"exception":true
},
"ListConfigurationSetsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token returned from a previous call to <code>ListConfigurationSets</code> to indicate the position of the configuration set in the configuration set list.</p>"
},
"MaxItems":{
"shape":"MaxItems",
"documentation":"<p>The number of configuration sets to return.</p>"
}
},
"documentation":"<p>Represents a request to list the configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"ListConfigurationSetsResponse":{
"type":"structure",
"members":{
"ConfigurationSets":{
"shape":"ConfigurationSets",
"documentation":"<p>A list of configuration sets.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of <code>ListConfigurationSets</code>. </p>"
}
},
"documentation":"<p>A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"ListIdentitiesRequest":{
"type":"structure",
"members":{
@ -1526,7 +2018,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>: Represents a request to list the IP address filters that exist under your AWS account. You use IP address filters when you receive email with Amazon SES. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html\">Amazon SES Developer Guide</a>.</p>"
"documentation":"<p>Represents a request to list the IP address filters that exist under your AWS account. You use IP address filters when you receive email with Amazon SES. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html\">Amazon SES Developer Guide</a>.</p>"
},
"ListReceiptFiltersResponse":{
"type":"structure",
@ -1644,6 +2136,30 @@
},
"exception":true
},
"MessageTag":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{
"shape":"MessageTagName",
"documentation":"<p>The name of the tag. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
},
"Value":{
"shape":"MessageTagValue",
"documentation":"<p>The value of the tag. The value must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
}
},
"documentation":"<p>Contains the name and value of a tag that you can provide to <code>SendEmail</code> or <code>SendRawEmail</code> to apply to an email.</p> <p>Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"MessageTagList":{
"type":"list",
"member":{"shape":"MessageTag"}
},
"MessageTagName":{"type":"string"},
"MessageTagValue":{"type":"string"},
"NextToken":{"type":"string"},
"NotificationAttributes":{
"type":"map",
@ -2060,7 +2576,7 @@
},
"DeliveryAttempts":{
"shape":"Counter",
"documentation":"<p>Number of emails that have been enqueued for sending.</p>"
"documentation":"<p>Number of emails that have been sent.</p>"
},
"Bounces":{
"shape":"Counter",
@ -2116,6 +2632,14 @@
"ReturnPathArn":{
"shape":"AmazonResourceName",
"documentation":"<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter.</p> <p>For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p> <p>For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>. </p>"
},
"Tags":{
"shape":"MessageTagList",
"documentation":"<p>A list of tags, in the form of name/value pairs, to apply to an email that you send using <code>SendEmail</code>. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.</p>"
},
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set to use when you send an email using <code>SendEmail</code>.</p>"
}
},
"documentation":"<p>Represents a request to send a single formatted email using Amazon SES. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html\">Amazon SES Developer Guide</a>.</p>"
@ -2158,6 +2682,14 @@
"ReturnPathArn":{
"shape":"AmazonResourceName",
"documentation":"<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter.</p> <p>For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p> <p>Instead of using this parameter, you can use the X-header <code>X-SES-RETURN-PATH-ARN</code> in the raw message of the email. If you use both the <code>ReturnPathArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>ReturnPathArn</code> parameter.</p> <note> <p>For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html\">Amazon SES Developer Guide</a>.</p> </note>"
},
"Tags":{
"shape":"MessageTagList",
"documentation":"<p>A list of tags, in the form of name/value pairs, to apply to an email that you send using <code>SendRawEmail</code>. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.</p>"
},
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set to use when you send an email using <code>SendRawEmail</code>.</p>"
}
},
"documentation":"<p>Represents a request to send a single raw email using Amazon SES. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html\">Amazon SES Developer Guide</a>.</p>"
@ -2375,6 +2907,30 @@
"Optional"
]
},
"UpdateConfigurationSetEventDestinationRequest":{
"type":"structure",
"required":[
"ConfigurationSetName",
"EventDestination"
],
"members":{
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set that you want to update.</p>"
},
"EventDestination":{
"shape":"EventDestination",
"documentation":"<p>The event destination object that you want to apply to the specified configuration set.</p>"
}
},
"documentation":"<p>Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>"
},
"UpdateConfigurationSetEventDestinationResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>An empty element returned on a successful request.</p>"
},
"UpdateReceiptRuleRequest":{
"type":"structure",
"required":[

722
botocore/data/sms/2016-10-24/service-2.json Normal file
View file

@ -0,0 +1,722 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-10-24",
"endpointPrefix":"sms",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"SMS",
"serviceFullName":"AWS Server Migration Service",
"signatureVersion":"v4",
"targetPrefix":"AWSServerMigrationService_V2016_10_24"
},
"operations":{
"CreateReplicationJob":{
"name":"CreateReplicationJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateReplicationJobRequest"},
"output":{"shape":"CreateReplicationJobResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"MissingRequiredParameterException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"OperationNotPermittedException"},
{"shape":"ServerCannotBeReplicatedException"},
{"shape":"ReplicationJobAlreadyExistsException"},
{"shape":"NoConnectorsAvailableException"},
{"shape":"InternalError"}
],
"documentation":"The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS. Call this API to first create a ReplicationJob, which will then schedule periodic ReplicationRuns to replicate your server to AWS. Each ReplicationRun will result in the creation of an AWS AMI."
},
"DeleteReplicationJob":{
"name":"DeleteReplicationJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteReplicationJobRequest"},
"output":{"shape":"DeleteReplicationJobResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"MissingRequiredParameterException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"OperationNotPermittedException"},
{"shape":"ReplicationJobNotFoundException"}
],
"documentation":"The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns. This will delete the contents of the S3 bucket used to store SMS artifacts, but will not delete any AMIs created by the SMS service."
},
"DeleteServerCatalog":{
"name":"DeleteServerCatalog",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteServerCatalogRequest"},
"output":{"shape":"DeleteServerCatalogResponse"},
"errors":[
{"shape":"UnauthorizedOperationException"},
{"shape":"OperationNotPermittedException"},
{"shape":"InvalidParameterException"},
{"shape":"MissingRequiredParameterException"}
],
"documentation":"The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be accessible to the Server Migration Service."
},
"DisassociateConnector":{
"name":"DisassociateConnector",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateConnectorRequest"},
"output":{"shape":"DisassociateConnectorResponse"},
"errors":[
{"shape":"MissingRequiredParameterException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"OperationNotPermittedException"},
{"shape":"InvalidParameterException"}
],
"documentation":"The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs."
},
"GetConnectors":{
"name":"GetConnectors",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetConnectorsRequest"},
"output":{"shape":"GetConnectorsResponse"},
"errors":[
{"shape":"UnauthorizedOperationException"}
],
"documentation":"The GetConnectors API returns a list of connectors that are registered with the Server Migration Service."
},
"GetReplicationJobs":{
"name":"GetReplicationJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetReplicationJobsRequest"},
"output":{"shape":"GetReplicationJobsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"MissingRequiredParameterException"},
{"shape":"UnauthorizedOperationException"}
],
"documentation":"The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationJobs."
},
"GetReplicationRuns":{
"name":"GetReplicationRuns",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetReplicationRunsRequest"},
"output":{"shape":"GetReplicationRunsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"MissingRequiredParameterException"},
{"shape":"UnauthorizedOperationException"}
],
"documentation":"The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationRuns for a ReplicationJob."
},
"GetServers":{
"name":"GetServers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetServersRequest"},
"output":{"shape":"GetServersResponse"},
"errors":[
{"shape":"UnauthorizedOperationException"}
],
"documentation":"The GetServers API returns a list of all servers in your server catalog. For this call to succeed, you must previously have called ImportServerCatalog."
},
"ImportServerCatalog":{
"name":"ImportServerCatalog",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ImportServerCatalogRequest"},
"output":{"shape":"ImportServerCatalogResponse"},
"errors":[
{"shape":"UnauthorizedOperationException"},
{"shape":"OperationNotPermittedException"},
{"shape":"InvalidParameterException"},
{"shape":"MissingRequiredParameterException"},
{"shape":"NoConnectorsAvailableException"}
],
"documentation":"The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises. This API call requires connectors to be installed and monitoring all servers you would like imported. This API call returns immediately, but may take some time to retrieve all of the servers."
},
"StartOnDemandReplicationRun":{
"name":"StartOnDemandReplicationRun",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartOnDemandReplicationRunRequest"},
"output":{"shape":"StartOnDemandReplicationRunResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"MissingRequiredParameterException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"OperationNotPermittedException"},
{"shape":"ReplicationRunLimitExceededException"}
],
"documentation":"The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency). This ReplicationRun will start immediately. StartOnDemandReplicationRun is subject to limits on how many on demand ReplicationRuns you may call per 24-hour period."
},
"UpdateReplicationJob":{
"name":"UpdateReplicationJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateReplicationJobRequest"},
"output":{"shape":"UpdateReplicationJobResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"MissingRequiredParameterException"},
{"shape":"OperationNotPermittedException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"ServerCannotBeReplicatedException"},
{"shape":"ReplicationJobNotFoundException"},
{"shape":"InternalError"}
],
"documentation":"The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob. Calling this API will affect the next scheduled ReplicationRun."
}
},
"shapes":{
"AmiId":{
"type":"string",
"documentation":"The AMI id for the image resulting from a Replication Run."
},
"Connector":{
"type":"structure",
"members":{
"connectorId":{"shape":"ConnectorId"},
"version":{"shape":"ConnectorVersion"},
"status":{"shape":"ConnectorStatus"},
"capabilityList":{"shape":"ConnectorCapabilityList"},
"vmManagerName":{"shape":"VmManagerName"},
"vmManagerType":{"shape":"VmManagerType"},
"vmManagerId":{"shape":"VmManagerId"},
"ipAddress":{"shape":"IpAddress"},
"macAddress":{"shape":"MacAddress"},
"associatedOn":{"shape":"Timestamp"}
},
"documentation":"Object representing a Connector"
},
"ConnectorCapability":{
"type":"string",
"documentation":"Capabilities for a Connector",
"enum":["VSPHERE"]
},
"ConnectorCapabilityList":{
"type":"list",
"member":{
"shape":"ConnectorCapability",
"locationName":"item"
},
"documentation":"List of Connector Capabilities"
},
"ConnectorId":{
"type":"string",
"documentation":"Unique Identifier for Connector"
},
"ConnectorList":{
"type":"list",
"member":{
"shape":"Connector",
"locationName":"item"
},
"documentation":"List of connectors"
},
"ConnectorStatus":{
"type":"string",
"documentation":"Status of on-premise Connector",
"enum":[
"HEALTHY",
"UNHEALTHY"
]
},
"ConnectorVersion":{
"type":"string",
"documentation":"Connector version string"
},
"CreateReplicationJobRequest":{
"type":"structure",
"required":[
"serverId",
"seedReplicationTime",
"frequency"
],
"members":{
"serverId":{"shape":"ServerId"},
"seedReplicationTime":{"shape":"Timestamp"},
"frequency":{"shape":"Frequency"},
"licenseType":{"shape":"LicenseType"},
"roleName":{"shape":"RoleName"},
"description":{"shape":"Description"}
}
},
"CreateReplicationJobResponse":{
"type":"structure",
"members":{
"replicationJobId":{"shape":"ReplicationJobId"}
}
},
"DeleteReplicationJobRequest":{
"type":"structure",
"required":["replicationJobId"],
"members":{
"replicationJobId":{"shape":"ReplicationJobId"}
}
},
"DeleteReplicationJobResponse":{
"type":"structure",
"members":{
}
},
"DeleteServerCatalogRequest":{
"type":"structure",
"members":{
}
},
"DeleteServerCatalogResponse":{
"type":"structure",
"members":{
}
},
"Description":{
"type":"string",
"documentation":"The description for a Replication Job/Run."
},
"DisassociateConnectorRequest":{
"type":"structure",
"required":["connectorId"],
"members":{
"connectorId":{"shape":"ConnectorId"}
}
},
"DisassociateConnectorResponse":{
"type":"structure",
"members":{
}
},
"ErrorMessage":{
"type":"string",
"documentation":"Error Message string"
},
"Frequency":{
"type":"integer",
"documentation":"Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs."
},
"GetConnectorsRequest":{
"type":"structure",
"members":{
"nextToken":{"shape":"NextToken"},
"maxResults":{"shape":"MaxResults"}
}
},
"GetConnectorsResponse":{
"type":"structure",
"members":{
"connectorList":{"shape":"ConnectorList"},
"nextToken":{"shape":"NextToken"}
}
},
"GetReplicationJobsRequest":{
"type":"structure",
"members":{
"replicationJobId":{"shape":"ReplicationJobId"},
"nextToken":{"shape":"NextToken"},
"maxResults":{"shape":"MaxResults"}
}
},
"GetReplicationJobsResponse":{
"type":"structure",
"members":{
"replicationJobList":{"shape":"ReplicationJobList"},
"nextToken":{"shape":"NextToken"}
}
},
"GetReplicationRunsRequest":{
"type":"structure",
"required":["replicationJobId"],
"members":{
"replicationJobId":{"shape":"ReplicationJobId"},
"nextToken":{"shape":"NextToken"},
"maxResults":{"shape":"MaxResults"}
}
},
"GetReplicationRunsResponse":{
"type":"structure",
"members":{
"replicationJob":{"shape":"ReplicationJob"},
"replicationRunList":{"shape":"ReplicationRunList"},
"nextToken":{"shape":"NextToken"}
}
},
"GetServersRequest":{
"type":"structure",
"members":{
"nextToken":{"shape":"NextToken"},
"maxResults":{"shape":"MaxResults"}
}
},
"GetServersResponse":{
"type":"structure",
"members":{
"lastModifiedOn":{"shape":"Timestamp"},
"serverCatalogStatus":{"shape":"ServerCatalogStatus"},
"serverList":{"shape":"ServerList"},
"nextToken":{"shape":"NextToken"}
}
},
"ImportServerCatalogRequest":{
"type":"structure",
"members":{
}
},
"ImportServerCatalogResponse":{
"type":"structure",
"members":{
}
},
"InternalError":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"An internal error has occured.",
"exception":true,
"fault":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"A parameter specified in the request is not valid, is unsupported, or cannot be used.",
"exception":true
},
"IpAddress":{
"type":"string",
"documentation":"Internet Protocol (IP) Address"
},
"LicenseType":{
"type":"string",
"documentation":"The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun.",
"enum":[
"AWS",
"BYOL"
]
},
"MacAddress":{
"type":"string",
"documentation":"Hardware (MAC) address"
},
"MaxResults":{
"type":"integer",
"documentation":"The maximum number of results to return in one API call. If left empty, this will default to 50."
},
"MissingRequiredParameterException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.",
"exception":true
},
"NextToken":{
"type":"string",
"documentation":"Pagination token to pass as input to API call"
},
"NoConnectorsAvailableException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.",
"exception":true
},
"OperationNotPermittedException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.",
"exception":true
},
"ReplicationJob":{
"type":"structure",
"members":{
"replicationJobId":{"shape":"ReplicationJobId"},
"serverId":{"shape":"ServerId"},
"serverType":{"shape":"ServerType"},
"vmServer":{"shape":"VmServer"},
"seedReplicationTime":{"shape":"Timestamp"},
"frequency":{"shape":"Frequency"},
"nextReplicationRunStartTime":{"shape":"Timestamp"},
"licenseType":{"shape":"LicenseType"},
"roleName":{"shape":"RoleName"},
"latestAmiId":{"shape":"AmiId"},
"state":{"shape":"ReplicationJobState"},
"statusMessage":{"shape":"ReplicationJobStatusMessage"},
"description":{"shape":"Description"},
"replicationRunList":{"shape":"ReplicationRunList"}
},
"documentation":"Object representing a Replication Job"
},
"ReplicationJobAlreadyExistsException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"An active Replication Job already exists for the specified server.",
"exception":true
},
"ReplicationJobId":{
"type":"string",
"documentation":"The unique identifier for a Replication Job."
},
"ReplicationJobList":{
"type":"list",
"member":{
"shape":"ReplicationJob",
"locationName":"item"
},
"documentation":"List of Replication Jobs"
},
"ReplicationJobNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The specified Replication Job cannot be found.",
"exception":true
},
"ReplicationJobState":{
"type":"string",
"documentation":"Current state of Replication Job",
"enum":[
"PENDING",
"ACTIVE",
"FAILED",
"DELETING",
"DELETED"
]
},
"ReplicationJobStatusMessage":{
"type":"string",
"documentation":"String describing current status of Replication Job"
},
"ReplicationJobTerminated":{
"type":"boolean",
"documentation":"An indicator of the Replication Job being deleted or failed."
},
"ReplicationRun":{
"type":"structure",
"members":{
"replicationRunId":{"shape":"ReplicationRunId"},
"state":{"shape":"ReplicationRunState"},
"type":{"shape":"ReplicationRunType"},
"statusMessage":{"shape":"ReplicationRunStatusMessage"},
"amiId":{"shape":"AmiId"},
"scheduledStartTime":{"shape":"Timestamp"},
"completedTime":{"shape":"Timestamp"},
"description":{"shape":"Description"}
},
"documentation":"Object representing a Replication Run"
},
"ReplicationRunId":{
"type":"string",
"documentation":"The unique identifier for a Replication Run."
},
"ReplicationRunLimitExceededException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"This user has exceeded the maximum allowed Replication Run limit.",
"exception":true
},
"ReplicationRunList":{
"type":"list",
"member":{
"shape":"ReplicationRun",
"locationName":"item"
},
"documentation":"List of Replication Runs"
},
"ReplicationRunState":{
"type":"string",
"documentation":"Current state of Replication Run",
"enum":[
"PENDING",
"MISSED",
"ACTIVE",
"FAILED",
"COMPLETED",
"DELETING",
"DELETED"
]
},
"ReplicationRunStatusMessage":{
"type":"string",
"documentation":"String describing current status of Replication Run"
},
"ReplicationRunType":{
"type":"string",
"documentation":"Type of Replication Run",
"enum":[
"ON_DEMAND",
"AUTOMATIC"
]
},
"RoleName":{
"type":"string",
"documentation":"Name of service role in customer's account to be used by SMS service."
},
"Server":{
"type":"structure",
"members":{
"serverId":{"shape":"ServerId"},
"serverType":{"shape":"ServerType"},
"vmServer":{"shape":"VmServer"},
"replicationJobId":{"shape":"ReplicationJobId"},
"replicationJobTerminated":{"shape":"ReplicationJobTerminated"}
},
"documentation":"Object representing a server"
},
"ServerCannotBeReplicatedException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The provided server cannot be replicated.",
"exception":true
},
"ServerCatalogStatus":{
"type":"string",
"documentation":"Status of Server catalog",
"enum":[
"NOT_IMPORTED",
"IMPORTING",
"AVAILABLE",
"DELETED",
"EXPIRED"
]
},
"ServerId":{
"type":"string",
"documentation":"Unique Identifier for a server"
},
"ServerList":{
"type":"list",
"member":{
"shape":"Server",
"locationName":"item"
},
"documentation":"List of servers from catalog"
},
"ServerType":{
"type":"string",
"documentation":"Type of server.",
"enum":["VIRTUAL_MACHINE"]
},
"StartOnDemandReplicationRunRequest":{
"type":"structure",
"required":["replicationJobId"],
"members":{
"replicationJobId":{"shape":"ReplicationJobId"},
"description":{"shape":"Description"}
}
},
"StartOnDemandReplicationRunResponse":{
"type":"structure",
"members":{
"replicationRunId":{"shape":"ReplicationRunId"}
}
},
"Timestamp":{
"type":"timestamp",
"documentation":"Timestamp of an operation"
},
"UnauthorizedOperationException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"This user does not have permissions to perform this operation.",
"exception":true
},
"UpdateReplicationJobRequest":{
"type":"structure",
"required":["replicationJobId"],
"members":{
"replicationJobId":{"shape":"ReplicationJobId"},
"frequency":{"shape":"Frequency"},
"nextReplicationRunStartTime":{"shape":"Timestamp"},
"licenseType":{"shape":"LicenseType"},
"roleName":{"shape":"RoleName"},
"description":{"shape":"Description"}
}
},
"UpdateReplicationJobResponse":{
"type":"structure",
"members":{
}
},
"VmId":{
"type":"string",
"documentation":"Unique Identifier for a VM"
},
"VmManagerId":{
"type":"string",
"documentation":"Unique Identifier for VM Manager"
},
"VmManagerName":{
"type":"string",
"documentation":"VM Manager Name"
},
"VmManagerType":{
"type":"string",
"documentation":"VM Management Product",
"enum":["VSPHERE"]
},
"VmName":{
"type":"string",
"documentation":"Name of Virtual Machine"
},
"VmPath":{
"type":"string",
"documentation":"Path to VM"
},
"VmServer":{
"type":"structure",
"members":{
"vmServerAddress":{"shape":"VmServerAddress"},
"vmName":{"shape":"VmName"},
"vmManagerName":{"shape":"VmManagerName"},
"vmManagerType":{"shape":"VmManagerType"},
"vmPath":{"shape":"VmPath"}
},
"documentation":"Object representing a VM server"
},
"VmServerAddress":{
"type":"structure",
"members":{
"vmManagerId":{"shape":"VmManagerId"},
"vmId":{"shape":"VmId"}
},
"documentation":"Object representing a server's location"
}
},
"documentation":"Amazon Server Migration Service automates the process of migrating servers to EC2."
}

14
botocore/data/waf/2015-08-24/service-2.json
View file

@ -545,7 +545,7 @@
{"shape":"WAFReferencedItemException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Inserts or deletes <a>IPSetDescriptor</a> objects in an <code>IPSet</code>. For each <code>IPSetDescriptor</code> object, you specify the following values: </p> <ul> <li> <p>Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code> object, you delete the existing object and add a new one.</p> </li> <li> <p>The IP address version, <code>IPv4</code> or <code>IPv6</code>. </p> </li> <li> <p>The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code> (for the individual IP address <code>192.0.2.44</code>). </p> </li> </ul> <p>AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p> <p>IPv6 addresses can be represented using any of the following formats:</p> <ul> <li> <p>1111:0000:0000:0000:0000:0000:0000:0111/128</p> </li> <li> <p>1111:0:0:0:0:0:0:0111/128</p> </li> <li> <p>1111::0111/128</p> </li> <li> <p>1111::111/128</p> </li> </ul> <p>You use an <code>IPSet</code> to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that specifies those IP addresses, and then configure AWS WAF to block the requests. </p> <p>To create and configure an <code>IPSet</code>, perform the following steps:</p> <ol> <li> <p>Submit a <a>CreateIPSet</a> request.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</p> </li> <li> <p>Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for.</p> </li> </ol> <p>When you update an <code>IPSet</code>, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.</p> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
"documentation":"<p>Inserts or deletes <a>IPSetDescriptor</a> objects in an <code>IPSet</code>. For each <code>IPSetDescriptor</code> object, you specify the following values: </p> <ul> <li> <p>Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code> object, you delete the existing object and add a new one.</p> </li> <li> <p>The IP address version, <code>IPv4</code>. </p> </li> <li> <p>The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code> (for the individual IP address <code>192.0.2.44</code>). </p> </li> </ul> <p>AWS WAF supports /8, /16, /24, and /32 IP address ranges. For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p> <p>You use an <code>IPSet</code> to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that specifies those IP addresses, and then configure AWS WAF to block the requests. </p> <p>To create and configure an <code>IPSet</code>, perform the following steps:</p> <ol> <li> <p>Submit a <a>CreateIPSet</a> request.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</p> </li> <li> <p>Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for.</p> </li> </ol> <p>When you update an <code>IPSet</code>, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.</p> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"UpdateRule":{
"name":"UpdateRule",
@ -1523,10 +1523,10 @@
},
"IPSetDescriptors":{
"shape":"IPSetDescriptors",
"documentation":"<p>The IP address type (<code>IPV4</code> or <code>IPV6</code>) and the IP address range (in CIDR notation) that web requests originate from. If the <code>WebACL</code> is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:</p> <ul> <li> <p> <code>c-ip</code>, if the viewer did not use an HTTP proxy or a load balancer to send the request</p> </li> <li> <p> <code>x-forwarded-for</code>, if the viewer did use an HTTP proxy or a load balancer to send the request</p> </li> </ul>"
"documentation":"<p>The IP address type (<code>IPV4</code>) and the IP address range (in CIDR notation) that web requests originate from. If the <code>WebACL</code> is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:</p> <ul> <li> <p> <code>c-ip</code>, if the viewer did not use an HTTP proxy or a load balancer to send the request</p> </li> <li> <p> <code>x-forwarded-for</code>, if the viewer did use an HTTP proxy or a load balancer to send the request</p> </li> </ul>"
}
},
"documentation":"<p>Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6.</p> <p>To specify an individual IP address, you specify the four-part IP address followed by a <code>/32</code>, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify a <code>/128</code>, <code>/64</code>, <code>/56</code>, <code>/48</code>, <code>/32</code>, <code>/24</code>, <code>/16</code>, or <code>/8</code> CIDR. For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>. </p>"
"documentation":"<p>Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. To specify an individual IP address, you specify the four-part IP address followed by a <code>/32</code>, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify a <code>/24</code>, a <code>/16</code>, or a <code>/8</code> CIDR. For more information about CIDR notation, perform an Internet search on <code>cidr notation</code>.</p>"
},
"IPSetDescriptor":{
"type":"structure",
@ -1537,14 +1537,14 @@
"members":{
"Type":{
"shape":"IPSetDescriptorType",
"documentation":"<p>Specify <code>IPV4</code> or <code>IPV6</code>.</p>"
"documentation":"<p>Specify <code>IPV4</code>.</p>"
},
"Value":{
"shape":"IPSetDescriptorValue",
"documentation":"<p>Specify an IPv4 address by using CIDR notation. For example:</p> <ul> <li> <p>To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p> <p>Specify an IPv6 address by using CIDR notation. For example:</p> <ul> <li> <p>To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p> </li> <li> <p>To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p> </li> </ul>"
"documentation":"<p>Specify an IPv4 address by using CIDR notation. For example:</p> <ul> <li> <p>To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> </ul> <p>AWS WAF supports only /8, /16, /24, and /32 IP addresses.</p> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p>"
}
},
"documentation":"<p>Specifies the IP address type (<code>IPV4</code> or <code>IPV6</code>) and the IP address range (in CIDR format) that web requests originate from.</p>"
"documentation":"<p>Specifies the IP address type (<code>IPV4</code>) and the IP address range (in CIDR format) that web requests originate from.</p>"
},
"IPSetDescriptorType":{
"type":"string",
@ -1593,7 +1593,7 @@
},
"IPSetDescriptor":{
"shape":"IPSetDescriptor",
"documentation":"<p>The IP address type (<code>IPV4</code> or <code>IPV6</code>) and the IP address range (in CIDR notation) that web requests originate from.</p>"
"documentation":"<p>The IP address type (<code>IPV4</code>) and the IP address range (in CIDR notation) that web requests originate from.</p>"
}
},
"documentation":"<p>Specifies the type of update to perform to an <a>IPSet</a> with <a>UpdateIPSet</a>.</p>"

18
botocore/handlers.py
View file

@ -581,6 +581,19 @@ def document_glacier_tree_hash_checksum():
return AppendParamDocumentation('checksum', doc).append_documentation
def document_cloudformation_get_template_return_type(section, event_name, **kwargs):
if 'response-params' in event_name:
template_body_section = section.get_section('TemplateBody')
type_section = template_body_section.get_section('param-type')
type_section.clear_text()
type_section.write('(*dict*) --')
elif 'response-example' in event_name:
parent = section.get_section('structure-value')
param_line = parent.get_section('TemplateBody')
value_portion = param_line.get_section('member-value')
value_portion.clear_text()
value_portion.write('{}')
def switch_host_machinelearning(request, **kwargs):
switch_host_with_param(request, 'PredictEndpoint')
@ -848,7 +861,10 @@ BUILTIN_HANDLERS = [
AutoPopulatedParam('checksum').document_auto_populated_param),
('docs.request-params.glacier.CompleteMultipartUpload.complete-section',
document_glacier_tree_hash_checksum()),
# Cloudformation documentation customizations
('docs.*.cloudformation.GetTemplate.complete-section',
document_cloudformation_get_template_return_type),
# UserData base64 encoding documentation customizations
('docs.*.ec2.RunInstances.complete-section',
document_base64_encoding('UserData')),

24
botocore/stub.py
View file

@ -20,7 +20,22 @@ from botocore.exceptions import ParamValidationError, \
from botocore.vendored.requests.models import Response
ANY = object()
class _ANY(object):
"""
A helper object that compares equal to everything. Copied from
unittest.mock
"""
def __eq__(self, other):
return True
def __ne__(self, other):
return False
def __repr__(self):
return '<ANY>'
ANY = _ANY()
class Stubber(object):
@ -262,7 +277,7 @@ class Stubber(object):
the names of keyword arguments passed to that client call. If
any of the parameters differ a ``StubResponseError`` is thrown.
You can use stub.ANY to indicate a particular parameter to ignore
in validation. stub.ANY is only valid for top level params.
in validation.
"""
http_response = Response()
http_response.status_code = http_status_code
@ -326,10 +341,7 @@ class Stubber(object):
# Validate the parameters are equal
for param, value in expected_params.items():
if value is ANY:
continue
elif param not in params or \
expected_params[param] != params[param]:
if param not in params or expected_params[param] != params[param]:
raise StubAssertionError(
operation_name=model.name,
reason='Expected parameters:\n%s,\nbut received:\n%s' % (

2
docs/source/conf.py
View file

@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat'
# The short X.Y version.
version = '1.4.'
# The full version, including alpha/beta/rc tags.
release = '1.4.64'
release = '1.4.70'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

27
tests/functional/test_cloudformation.py Normal file
View file

@ -0,0 +1,27 @@
# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from tests.functional.docs import BaseDocsFunctionalTest
from botocore.docs.service import ServiceDocumenter
class TestCloudFormationDocs(BaseDocsFunctionalTest):
def test_get_template_response_documented_as_dict(self):
content = self.get_docstring_for_method('cloudformation', 'get_template')
# String return type should be gone
self.assert_not_contains_line(
"(*string*) --", content)
# Check for template body returning a dict
self.assert_contains_line(
"(*dict*) --", content)
# Check the specifics of the returned dict
self.assert_contains_line('{}', content)

38
tests/functional/test_stub.py
View file

@ -204,6 +204,44 @@ class TestStubber(unittest.TestCase):
except StubAssertionError:
self.fail("stub.ANY failed to ignore parameter for validation.")
def test_nested_any_param(self):
service_response = {}
expected_params = {
'Bucket': 'foo',
'Key': 'bar.txt',
'Metadata': {
'MyMeta': stub.ANY,
}
}
self.stubber.add_response(
'put_object', service_response, expected_params)
self.stubber.add_response(
'put_object', service_response, expected_params)
try:
with self.stubber:
self.client.put_object(
Bucket='foo',
Key='bar.txt',
Metadata={
'MyMeta': 'Foo',
}
)
self.client.put_object(
Bucket='foo',
Key='bar.txt',
Metadata={
'MyMeta': 'Bar',
}
)
except StubAssertionError:
self.fail(
"stub.ANY failed to ignore nested parameter for validation.")
def test_ANY_repr(self):
self.assertEqual(repr(stub.ANY), '<ANY>')
def test_none_param(self):
service_response = {}
expected_params = {'Buck': None}